Payments

Let an agent pay on a customer’s behalf with a single-use virtual card. Connect a customer once, then create a payment — a virtual card is minted scoped to that purchase and the card details are handed back for checkout.

Create a payment (agent pays on a customer's behalf)

payments.create() -> Payment

POST/v3/payments

Get a payment

payments.retrieve() -> Payment

GET/v3/payments/{paymentId}

Cancel a payment

payments.cancel() -> Payment

POST/v3/payments/{paymentId}/cancel

Get a payment's card-reveal handoff

payments.credentials() -> PaymentCredentialsResponse

GET/v3/payments/{paymentId}/credentials

ModelsExpand Collapse

class Payment: …

id: Optional[str]

amount_cents: Optional[int]

formatint64

approval_url: Optional[str]

Present on awaiting_user_action once a card is on file and the charge needs the customer’s passkey. Re-send the create request with the same Idempotency-Key to collect the payment after they approve.

attach_url: Optional[str]

Present on awaiting_user_action when the customer has no card on file yet. A hosted page — open it for them; it stays valid for about 48 hours. Not returned on needs_connection: connect the handle first.

currency: Optional[str]

description: Optional[str]

handle: Optional[str]

merchant: Optional[Merchant]

The merchant the card is minted against, echoed from the request.

name: Optional[str]

url: Optional[str]

metadata: Optional[Dict[str, str]]

Your own key/values, echoed back from the request.

status: Optional[Literal["needs_connection", "connecting", "awaiting_user_action", 6 more]]

One of the following:

"needs_connection"

"connecting"

"awaiting_user_action"

"ready"

"authorized"

"succeeded"

"declined"

"canceled"

"expired"

class PaymentCredentialsResponse: …

handoff: Optional[Handoff]

Fetch the card directly from the provider with these — never through Linq.

card_ref: Optional[str]

fetch_url: Optional[str]

provider: Optional[str]

user_token: Optional[str]

Short-lived bearer to fetch the card from the provider.