Group Payment Integration

Pre-requisites

• Setup your Hands In account - You must have created and set up a Hands In account before following this tutorial
• API Authentication - You must have retrieved your sandbox or live API key

How it works?

Server-to-server integration steps

1. Create a group payment session — POST /v1/group-payments with the total, the lineItemParams, a splitType, the group owner in customer, a unique idempotencyKey and (recommended in production) an expirationDate. See Create a Group Payment Session for full request and response examples.
2. Redirect the group owner to customerUrl — not url. The url field is the invite link that the owner shares with the rest of the group.
3. Optionally invite members and pre-allocate items up front — pass the invites and itemAllocation fields on creation so each member arrives at checkout with their share already assigned. See How to pre-allocate items.
4. Receive the outcome — subscribe to the group payment webhook events, or poll Retrieve a Group Payment Session.
5. Reconcile each member's contribution — see Reconcile Group Payments.