Skip to content
Get started

Payment Providers

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.

Start payment-provider onboarding
client.paymentProviders.connect(stringprovider, PaymentProviderConnectParams { return_url } body, RequestOptionsoptions?): PaymentProviderConnectResponse { hosted_url, session_id, status }
POST/v3/payments/providers/{provider}/connect
Get payment-provider status
client.paymentProviders.retrieve(stringprovider, RequestOptionsoptions?): PaymentProvider { provider, status }
GET/v3/payments/providers/{provider}
ModelsExpand Collapse
PaymentProvider { provider, status }
provider?: string
status?: "onboarding" | "ready" | "disabled"
One of the following:
"onboarding"
"ready"
"disabled"
PaymentProviderConnectResponse { hosted_url, session_id, status }
hosted_url?: string

Send the admin here to authorize the connection.

session_id?: string
status?: string