Documentation
Payout

Payout

The Brails Payouts API enables seamless cross-border money transfers to bank accounts and mobile money wallets across 49+ countries worldwide, including major markets like the United States, Europe, and China.

For comprehensive details on supported countries, available currencies, and transaction limits, visit our Supported Countries page.

To ensure successful payouts, we provide detailed country-specific beneficiary guides that outline requirements and best practices. Here are some our guides:

Each guide contains comprehensive information about supported payment methods, required fields, and country-specific requirements.

The flow for payout is as follows:

  1. Add the beneficiary
  2. Initiate payout
  3. Authorize/finalize payout
  4. Await transaction webhook and/or track transaction status

NB: You can skip the first step if the beneficiary has already been indexed.

To Initiate payout, the following parameters are required.

ParameterDescriptionRequired
amount amount you want to send in smaller denominations ie 1 USD = 100 cents.
sourceWalletCurrencyIndicates the wallet from which payment is made. Defaults to USD
reference reference to keep track of your transaction
customerEmail represents the email address of the customer associated with the transaction.
description provides context or explains the intent of the transaction.
beneficiaryId id of the beneficiary that has already been created/indexed
callbackUrl URL to send webhook to if per this transaction.

To Finalize Payout, the only parameter required is the transaction identifier.

ParameterDescriptionRequired
transactionIdthe transaction identifier returned when you initiate a payout.

📘 Payout Statuses

A payout transaction status can be any of the following

Text
 
INITIATED
PENDING
PROCESSING
SUCCESS
FAILED
EXPIRED
 

How many minutes does it take between initiating a transaction and finalising rate updates? - Approximately 4 minutes.