Redirect the user to PaySquad to allow them to begin the process of inviting others to pay
After you create a Paysquad, the Shopper needs to be redirected into our hosted flow to complete it.
How to redirect
The Create Paysquad response includes a contributionLink. Redirect the Shopper's browser to this URL.
| Environment | URL |
|---|---|
| Production | https://app.paysquad.co/flow/{paySquadId} |
| Sandbox | https://app.sandbox.paysquad.co/flow/{paySquadId} |
Use contributionLink rather than constructing the URL yourself; it already reflects the correct environment.
What happens in the hosted flow
The Squad Leader goes through:
- Authentication with Paysquad
- Reviewing their basket
- Making their own first contribution
- Inviting friends to contribute
Other Shoppers follow the same link to join as Contributors. Paysquad captures funds once the total is met.
Redirects back to you
If you supplied successRedirectUrl or cancelRedirectUrl at creation time:
successRedirectUrlis offered to the Squad Leader after they make their first contribution, as a "back to shop" link.cancelRedirectUrlis used if the Squad Leader cancels the Paysquad before completing.
Neither redirect carries payment-status information; it's a navigation convenience only.
Source of truth for Paysquad state
Do not rely on redirects to know the final state of a Paysquad. Always use webhooks (preferred) or poll GET /api/merchant/paysquad/{id}. A Paysquad typically completes minutes to days after creation, long after the Shopper has left your site.