Skip to main content
GET
Open a payment capture link

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

token
string
required

The single-use capture-link token from the URL issued by add_payment_authority. The token is the authorization — no session or API key applies.

Pattern: ^[A-Za-z0-9_-]{40,64}$

Query Parameters

view
enum<string>

Pass status for the cheap status-only poll: returns status and expiry without opening the link or minting card-form credentials.

Available options:
status

Response

Open a payment capture link

Validates the capture-link token, marks it opened, and returns everything the hosted page needs to mount the embedded card form (or render the current status if already verified/expired).

status
enum<string>
required

pending: issued, not yet opened. opened: the hosted page exchanged the token at least once. verified: the card-rail webhook confirmed a payment method for this link. expired: the TTL elapsed before verification — terminal, never re-armed.

Available options:
pending,
opened,
verified,
expired
expiresAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
orgDisplayName
string

The requesting org's display name, shown so the cardholder knows whose payment method they're adding. Omitted from the status-only poll view.

clientSecret
string

The capture-session client secret for the embedded card form. Present only while status is pending or opened.

publishableKey
string