Recipients
Save who you pay and how, once, then pay them as often as you like.
A recipient pairs a currency with a payout method (a rail, such as bank, mobile_money or interac) and the destination details that rail needs.
Add a recipient
Ask GET /payouts/requirements which rails the currency supports and which destination fields each needs. Build your form from it rather than hard-coding fields: it is the source of truth.
For bank and mobile money rails, get the institution code from GET /payouts/banks.
Where supported, confirm the account holder's name with POST /payouts/validate-account and show it to your user before saving. It catches typos before money moves.
Save it with POST /recipients and keep the returned id for payouts.
Tips
- Validate once, at creation. You do not need to validate again for each payout.
- One recipient per destination. To pay the same person in another currency or by another method, create another recipient.
- List what you have saved with
GET /recipients.
Then send a payout.