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)

POST/v3/payments

Get a payment

GET/v3/payments/{paymentId}

Cancel a payment

POST/v3/payments/{paymentId}/cancel

Get a payment's card-reveal handoff

GET/v3/payments/{paymentId}/credentials

ModelsExpand Collapse

Payment object { id, amount_cents, approval_url, 7 more }

id: optional string

amount_cents: optional number

formatint64

approval_url: optional string

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 string

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 string

description: optional string

handle: optional string

merchant: optional object { name, url }

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

name: optional string

url: optional string

metadata: optional map[string]

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

status: optional "needs_connection" or "connecting" or "awaiting_user_action" or 6 more

One of the following:

"needs_connection"

"connecting"

"awaiting_user_action"

"ready"

"authorized"

"succeeded"

"declined"

"canceled"

"expired"

PaymentCredentialsResponse object { handoff }

handoff: optional object { card_ref, fetch_url, provider, user_token }

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

card_ref: optional string

fetch_url: optional string

provider: optional string

user_token: optional string

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