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

payment_handles.connect() -> PaymentHandleConnection

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

Submit a customer's one-time code

payment_handles.verify(, ) -> PaymentHandleConnection

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

Get a handle's connection status

payment_handles.connection() -> PaymentHandleConnection

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

Revoke a handle's connection

payment_handles.revoke() -> PaymentHandleConnection

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

ModelsExpand Collapse

class PaymentHandleConnection: …

connect_id: Optional[str]

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: Optional[str]

status: Optional[Literal["not_connected", "pending", "connected", "revoked"]]

One of the following:

"not_connected"

"pending"

"connected"

"revoked"