WinkPG Docs

View as Markdown

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:52 UTC.

`MerchantBillingCaptureLinkStatusDto`

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

Operator-visible status of the outstanding send-a-link capture link for a merchant's stored payment method. Returned when you read the capture-link status and when you cancel a capture link. Carries only non-sensitive link metadata: never a token, recipient PII, or any card/account detail.

Values

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields

Field Type Description

status required

MerchantBillingCaptureLinkStatus MerchantBillingCaptureLinkStatus

The derived status of the latest link for this merchant (None when no link was ever sent).

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`None`	No capture link has been sent for this merchant (no link-origin intent exists).
`Pending`	A link has been sent and is still usable: issued, not yet consumed, not cancelled, and not past its expiry. The merchant can complete the hosted page; the operator can resend or cancel it.
`Completed`	The merchant completed the hosted page: the bound capture-intent was consumed.
`Expired`	The link passed its expiry without being consumed or cancelled. It can be reissued.
`Cancelled`	An operator revoked the link before it was used. Its hosted page can no longer be completed; it can be reissued.

kind required

MerchantBillingPaymentMethodKind MerchantBillingPaymentMethodKind

Card or ACH: the instrument family the outstanding link captures. Null when no link exists; a resend reissue reuses this kind so the operator is never asked to re-pick it. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Card`	Credit or debit card token. Brand, last 4, and expiry are populated.
`Ach`	ACH bank account token. AchAccountType and account last 4 are populated.

expiresAt required

string (date-time)

When the link (and its bound session/intent) expires, in UTC. Null when no link exists. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

canResend required

boolean

Whether a resend action is available: true whenever a link exists (a usable link is resent for its existing session; an expired/cancelled/completed one is reissued fresh). read only

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

canCancel required

boolean

Whether a cancel action is available: only a still-usable (pending) link can be revoked. read only

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This model has no documented fields.