Paysquad is a group-payment platform. At checkout, your server creates a Paysquad via our API and redirects the Shopper into our hosted flow. The Shopper becomes the Squad Leader, shares the link with friends or family, everyone contributes, and Paysquad captures and settles the full amount when the total is met.
This reference covers our REST API and webhooks. You'll use it to:
- Create a Paysquad from your checkout and redirect the Shopper into our hosted flow
- Receive webhook events when a Paysquad succeeds, fails, or is cancelled
- Fetch Paysquad details for reconciliation
- Request refunds on completed Paysquads
The API is REST over HTTPS. Requests and responses are JSON. Authentication is HTTP Basic. Amounts are always in minimum fractional currency units (for example, 22050 means $220.50).
Environments
- Production:
https://api.paysquad.co. Shopper-facing, real funds. - Sandbox:
https://api.sandbox.paysquad.co. Integration testing, no real funds.
Each environment has its own API keys and webhook signing keys. They are not interchangeable.
Getting started
- Fill out the Merchant Application form on our website.
- We'll invite your to our Sandbox environment.
- Wire up Create Paysquad and the hosted-flow redirect.
- Implement webhook receipt and signature validation.
- Test end-to-end in sandbox, then request production access.