Payment Handles

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.

Connect a customer handle

client.PaymentHandles.Connect(ctx, handle) (*PaymentHandleConnection, error)

POST/v3/payments/handles/{handle}/connect

Submit a customer's one-time code

client.PaymentHandles.Verify(ctx, handle, body) (*PaymentHandleConnection, error)

POST/v3/payments/handles/{handle}/verify

Get a handle's connection status

client.PaymentHandles.Connection(ctx, handle) (*PaymentHandleConnection, error)

GET/v3/payments/handles/{handle}/connection

Revoke a handle's connection

client.PaymentHandles.Revoke(ctx, handle) (*PaymentHandleConnection, error)

DELETE/v3/payments/handles/{handle}/connection

ModelsExpand Collapse

type PaymentHandleConnection struct{…}

ConnectID stringOptional

Returned only by connect, and only while the ceremony is pending. Nothing on our side persists it — it comes back from the provider and is required again to verify — so hold it until you submit the code.

Handle stringOptional

Status PaymentHandleConnectionStatusOptional

One of the following:

const PaymentHandleConnectionStatusNotConnected PaymentHandleConnectionStatus = "not_connected"

const PaymentHandleConnectionStatusPending PaymentHandleConnectionStatus = "pending"

const PaymentHandleConnectionStatusConnected PaymentHandleConnectionStatus = "connected"

const PaymentHandleConnectionStatusRevoked PaymentHandleConnectionStatus = "revoked"