How it works
Create a global payout
You initiate a payout in self-collect mode by providing the recipient’s email address and the amount. Syncgram Pay reserves the funds from your Financial Account balance and sends the recipient an email with a secure claim link.
Recipient opens the link
The recipient clicks the link and lands on the self-collect page. Opening the page marks the payout as started and prevents you from cancelling it.
Recipient submits their details
The recipient enters their name, country, and payment details (bank account, mobile wallet, or crypto address), then verifies their email with a one-time code.
Self-collect links expire after 7 days. If the recipient does not claim the payout within that window, the funds are released back to your Financial Account balance.
Self-collect flow
The self-collect flow uses three public endpoints. These endpoints do not require authentication — they are protected by a single-use signed token embedded in the claim link.Validate the claim token
Before rendering the self-collect page, validate the token to confirm it is active and retrieve the payout context.The current status of the token. One of:
active, claimed, expired, cancelled.The display name of the merchant sending the payout.
The payout amount in
currency.ISO 8601 timestamp when the claim token expires.
Payouts at or above this USD equivalent may require the recipient to complete identity verification.
404 or 410 error.
Start collection
Call this endpoint when the recipient first opens the self-collect page. This marks the payout as started and blocks merchant cancellation.started_at.
Submit recipient details
The recipient submits their identity and payment details. Syncgram Pay verifies the email OTP, creates the recipient record, and triggers payout processing.- Bank transfer
- Mobile money
- Crypto wallet
Submit request fields
email_verification object
The verification session ID returned when the OTP was sent to the recipient’s email.
The one-time code the recipient received by email.
recipient object
Recipient type:
individual or business.Required when
type is individual.Required when
type is individual.Required when
type is business.The recipient’s country in ISO 3166-1 alpha-2 format, e.g.
NG, GH, US.The recipient’s email address. Must match the email that received the claim link.
payment_method object
The payment method type:
bank_transfer, mobile_money, or crypto_wallet.The currency the recipient wants to receive, e.g.
NGN, GHS, USDT_TRC20.Bank account number. Required for
bank_transfer.Bank routing code. Required for
bank_transfer.Bank display name. Optional for
bank_transfer.Mobile number in international format. Required for
mobile_money.Mobile network operator code, e.g.
MTN, Vodafone. Required for mobile_money.On-chain wallet address. Required for
crypto_wallet.Blockchain network, e.g.
TRC20, ERC20. Required for crypto_wallet when not encoded in currency.Stablecoin ticker, e.g.
USDT. Required for crypto_wallet stablecoin transfers.Payout statuses
Global payouts follow an extended lifecycle to account for the self-collect hold period.| Status | Description |
|---|---|
pending_collection | The claim link has been sent. Waiting for the recipient to submit their details. |
processing | The recipient has submitted their details and the payout is being settled. |
successful | The payout has been delivered to the recipient. |
failed | The payout could not be completed. Funds are released back to your balance. |
cancelled | You cancelled the payout before the recipient opened the link. |
expired | The claim link expired before the recipient claimed the payout. Funds are released back to your balance. |
Use cases
Contractor payments
Pay freelancers and contractors without asking them to share their bank details upfront. They enter their own details securely when claiming the payout.
Creator payouts
Disburse earnings to creators across multiple countries. Each creator self-selects their preferred payment method.
Marketplace sellers
Settle funds to marketplace sellers without building a destination collection flow into your onboarding.
Refunds and reimbursements
Issue refunds or expense reimbursements to individuals without requiring them to have a pre-registered account.