Prerequisites
| What | Why | Where to get it |
|---|---|---|
| Consul API key | Authenticate API requests from your backend | Dashboard |
| Funded Consul balance | Payouts draw from your balance | Pre-Funding Flows |
| Webhook endpoint | Receive real-time payout status updates | Events and Webhooks |
How It Works
When a sale completes on your platform, your backend calls the Create a Payout endpoint with the seller’s email and amount. Consul handles the rest:- If the seller already has a Consul account, USDC lands in their wallet in seconds.
- If they’re new, Consul sends an email invite. A wallet is created behind the scenes and funds are held securely until the seller claims their account.
Tracking Payouts
Register a webhook endpoint and subscribe topayout.updated events. This tells you when each
payout item settles or fails. You can also poll GET /payouts/ if you prefer.
A payout status of
pending_claim means the seller hasn’t created their Consul account yet. Funds are held
securely. The seller can claim the funds before the payout expires or is cancelled.If cancelled via Cancel a Payout, funds are refunded to your Consul balance.
