How payouts work
Add a destination
Save the recipient’s bank account, mobile money number, or crypto wallet address as a payout destination on your organization.
Get a fee estimate
Call the estimate endpoint to preview the fee, net amount, and exchange rate before committing to a payout.
Lock a quote (cross-currency)
For cross-currency payouts, create a quote to lock the exchange rate for a short window.
Create a withdrawal
Submit the withdrawal request with the destination, amount, and your unique reference. Syncgram Pay returns an immediate status and begins processing.
Destination types
Syncgram Pay supports three destination types:| Type | Description |
|---|---|
bank_account | Direct bank transfers. Requires account number, account name, and bank code. |
mobile_money | Mobile wallet disbursements. Requires a phone number and mobile provider. |
crypto_wallet | Stablecoin and crypto transfers. Requires a wallet address and network (e.g., USDT_TRC20). |
Payout lifecycle
Every payout moves through the following states:| Status | Description |
|---|---|
PENDING | The withdrawal request has been received and is queued for processing. |
PROCESSING | The payout has been submitted to the payment provider and is being settled. |
COMPLETED | Funds have been delivered to the recipient’s account. |
FAILED | The payout could not be completed. The failure reason is returned in the response. |
Failed payouts do not consume your balance. Funds are returned to your available balance when a payout fails.
Test and live modes
All payout endpoints work in both test and live modes. Use your test API key to simulate payouts without moving real funds. Switch to your live API key when you are ready to process real disbursements. Destinations and withdrawals created in test mode are isolated from live mode — they do not carry over.Idempotency
Pass anidempotency_key field when creating a withdrawal to prevent duplicate payouts from being created if a request is retried. Syncgram Pay caches withdrawal responses for 30 minutes and returns the original response for any subsequent requests with the same key.
Explore
Destinations
Add and manage bank accounts, mobile wallets, and crypto addresses.
Withdrawals
Initiate payouts, get fee estimates, and lock exchange rates.
Global Payouts
Send payouts to recipients who self-onboard with their own payment details.