How It Works
1
Check the rules
Start with Get Payee Rules (Mandatory Fields)
so you know which fields are required for the payment.
2
Review bank and rate data
Use List Payout Banks and
Get Exchange Rates
before you submit the payment.
3
Save the payee details
Add the recipient’s Payee Address
and Payee Bank.
You can reuse them for future payments.
4
Create the payment
Submit the transfer with
Create a Cross-Border Payment.
Payee addresses and banks are stored per user (
user_id). Set them up once and reuse them for
every subsequent payout to that recipient.Reference Data & Rates
List Payout Banks
List the available payout banks for supported destinations.
Get Exchange Rates
View the exchange rate information used when creating a payout.
Get Payee Rules (Mandatory Fields)
Inspect the payee-specific mandatory fields required before creating a payout.
Payee Setup
Addresses
Add a Payee Address
Save a payee address for a user before bank setup or payout creation.
Get a Payee Address
Retrieve a specific saved payee address by user and address ID.
Edit a Payee Address
Update a saved payee address for a specific user.
List Payee Addresses
Retrieve all saved payee addresses for a specific user.
Bank Accounts
Add a Payee Bank
Save a payee bank account for cross-border payouts.
List Payee Banks
Retrieve all saved payee bank accounts for a specific user.
Delete a Payee Bank
Remove a saved payee bank account for a user.
Payments
Create a Cross-Border Payment
Create and submit a new cross-border payment for a user’s payee.
Best Practices
- Always read Payee Rules for the target corridor before collecting payee details — required fields vary by country and bank.
- Fetch Exchange Rates close to payout time so quoted amounts reflect current rates.
- Reuse saved payee addresses and banks instead of recreating them for every payout.
- Use webhooks or your own downstream reconciliation flow rather than assuming success on creation.