BankTransfer
This endpoint allows you to submit a BankTransfer payout in Ethiopia.
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
name
string
Required
Length must between 5 and 100.
Beneficiary name.
bank_code
string
Required
Use a supported Ethiopia bank_code returned by the Bank Account List API
Beneficiary bank code.
account
string
Required
Max length: 20
Beneficiary bank account number.
fee_bear
string
Required
All fees charge to merchant or beneficiary. - One of: merchant, beneficiary -
Indicates who bears the payout fee.
amount
string
Required
Min: 300; max: 9999999
Payout amount.
source_currency
string
Required
One of :USD, EUR, GBP,ETB
Merchant account currency.
arrival_currency
string
Required
Fixed value: ETB
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: ETH
Destination country.
method
string
Required
Fixed value: BANKTRANSFER
Payout method.
phone
string
Required
Beneficiary's phone
Max Length: 15, valid phone
Beneficiary phone number.
Request Sample
{
"name": "MA********UI",
"bank_code": "1217",
"account": "26********77",
"fee_bear": "merchant",
"amount": "300.00",
"source_currency": "USD",
"arrival_currency": "ETB",
"notify_url": "https://sandbox.transfersmile.com/api/notify/demo",
"custom_code": "custom_code********j4",
"additional_remark": "banktransfer payout request",
"country": "ETH",
"method": "BANKTRANSFER",
"phone" : "25********35"
}Response Sample
Query Bank Code
Use the Bank Account List API to retrieve the supported bank_code values for Ethiopia BankTransfer payouts.
POST https://sandbox.transfersmile.com/api/payout/bank-account-list
Request Sample
Error Codes
For more information about payout error codes, please refer to Payout API Code.
Last updated