Working with Group Payment Sessions
Learn how to work with group payment sessions using the Hands In API.
Get MarkdownA group payment session tracks a shared total that several people contribute to. You create the session with the total, its line items and the
group owner, redirect the owner to the customerUrl in the response, and they invite the rest of the group from there. Progress reaches your
system through webhooks, or by polling the session.
Create a session
Send a POST request with the total, line items, split type and the group owner, then redirect the owner to customerUrl.
Retrieve a session
Fetch a session by id to see members, invites, item allocation and each member's payment.
Session statuses
| Status | Meaning |
|---|---|
PENDING | The session has been created and is waiting on the group. |
APPROVED | Every share of the total has been authorized. |
COMPLETED | The authorized payments have been captured. |
EXPIRED | The session passed its expirationDate before the total was authorized. |
CANCELLED | The session was cancelled, and any outstanding authorizations were voided. |
Redirect the group owner to customerUrl, not url. The url field is the group invite link that the owner shares with the rest of the
group.
Once the flow works end to end, see Reconcile Group Payments for matching each member's contribution back to your own order records.