BankTransfer

How to use Bank Transfer to submit a payout in Nigeria.

This endpoint allows you to submit a BankTransfer payout in Nigeria.

Before submitting a payout, use the Bank Account List API to retrieve the supported bank_code values.

POST https://sandbox.transfersmile.com/api/payout

Request Body

Parameter	Type	Required	Constraints	Description
name	string	Required	Length must between 5 and 100.	Beneficiary name.
bank_code	string	Required	Use a supported Nigeria bank_code returned by the Bank Account List API	Beneficiary bank code.
account	string	Required	The account number must be 8–20 digits.	Beneficiary bank account number.
fee_bear	string	Required	Merchant beneficiary	Indicates who bears the payout fee.
amount	string	Required	Min: 100; max: 10000000	Payout amount.
source_currency	string	Required	Merchant Account Currency - One of :USD, EUR, GBP，NGN	Merchant account currency.
arrival_currency	string	Required	Fixed value: NGN	Currency received by the beneficiary.
notify_url	string	Required	Valid URL	The URL to receive payout notifications.
custom_code	string	Required	Max length: 64	Merchant payout order number. Must be unique.
additional_remark	string	Required	Max length: 255	Additional payout remark.
country	string	Required	Fixed value: NGA	Destination country.
method	string	Required	Fixed value: BANKTRANSFER	Payout method.
phone	string	Optional	Beneficiary's phone Max Length: 15, valid phone	Beneficiary phone number.
email	string	Required	Valid email address	Beneficiary email address.

Request Sample

{
  "name": "On********ma",
  "bank_code": "000014",
  "account": "00********38",
  "fee_bear": "merchant",
  "amount": "100.01",
  "source_currency": "USD",
  "arrival_currency": "NGN",
  "notify_url": "https://sandbox.transfersmile.com/api/notify/demo",
  "custom_code": "custom_code31********",
  "additional_remark": "banktransfer payout request",
  "country": "NGA",
  "method": "BANKTRANSFER",
  "email": "[e-mail]"
}

Response Sample

{
  "code": 200,
  "msg": "success",
  "time": 1785825013,
  "data": {
    "id": "TS2026********",
    "custom_code": "custom_code31********",
    "arrival_amount": "100.01",
    "arrival_currency": "NGN",
    "source_amount": "0.08",
    "source_currency": "USD",
    "status": "IN_PROCESSING"
  }
}

Query Bank Code

Use the Bank Account List API to retrieve the supported bank_code values for Nigeria BankTransfer payouts.

POST https://sandbox.transfersmile.com/api/payout/bank-account-list

Request Sample

{
  "timestamp": "1785209298",
  "method": "BANKTRANSFER",
  "country": "NGA"
}

Error Codes

For more information about payout error codes, please refer to Payout API Code.