Working with Multi Card Sessions
Learn how to work with multi card payment sessions using the Hands In API.
Get MarkdownA multi card payment session is the object that tracks one customer's split payment from creation through to completion. You create the session
with the total you want collected, hand the customer the hosted checkout url it returns, and then either wait for
webhooks or poll the session to see how far along it is.
Create a session
Send a POST request with the total, the customer, and an idempotency key, then redirect the customer to the url in the response.
Retrieve a session
Fetch a session by id to check its status and the individual payments made into it.
Session statuses
| Status | Meaning |
|---|---|
PENDING | The session has been created and is waiting on the customer. |
APPROVED | The full total has been authorized across the customer's cards. |
COMPLETED | The authorized payments have been captured. |
EXPIRED | The session passed its expiration date before the total was authorized. |
CANCELLED | The session was cancelled, and any outstanding authorizations were voided. |
Once you have a session working end to end, see Reconcile Multi Card Payments for matching the individual card payments back to your own order records.