BankTransfer
How to use Bank Transfer to submit a payout in Nigeria.
Submit a payout by Bank Transfer in Nigeria
POST
https://sandbox.transfersmile.com/api/payout
This endpoint allows you to submit a payout by Bank Transfer in Nigeria.
Headers
Content-Type*
string
application/json; charset=UTF-8
AppId*
string
Your App ID in payout platform.
Authorization*
string
SHA256($sorted_params + $app_key)
Request Body
name*
string
Beneficiary's name - Length must between 5 and 100 -
email*
string
Beneficiary's email
bank_code*
string
account*
string
Beneficiary's Bank Account
- 1 ~ 20 digits -
method*
string
Fixed value: BANKTRANSFER
custom_code*
string
Merchant Payout ID - Max. 50 chars -
fee_bear*
string
Processing fee charges to merchant or beneficiary - One of: merchant, beneficiary -
amount*
number
Payout Amount, 2 decimal numbers
- Min 100, Max 10,000,000 -
source_currency*
string
Merchant Account Currency - One of: USD, EUR, GBP, NGN -
arrival_currency*
string
Fixed value: NGN
notify_url*
string
Where pagsmile will send notification to.
additional_remark*
string
Descriptor on the user's bank bill - Max. 40 chars -
country*
string
NGA for Nigeria
amount_type
string
Specify the amount value is fixed for merchant or beneficiary - One of: source_amount, arrival_amount(default) -
{
"code": 200,
"msg": "success",
"time": 1628580845,
"data": {
"id": "TS202108100734054iRiUZFPXfQM",
"custom_code": "custom_code9982674851738108",
"arrival_amount": "0.51",
"arrival_currency": "BRL",
"source_amount": "0.07",
"source_currency": "USD",
"status": "IN_PROCESSING"
}
}
Example
curl --location --request POST 'https://sandbox.transfersmile.com/api/payout' \
--header 'AppId: 94FAC**********************68548' \
--header 'Authorization: d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302' \
--header 'Content-Type: application/json' \
--data-raw '{
* "name" : "GUILHERME ****** SOUZA",
* "email": "payout@pagsmile.com",
* "bank_code": "058",
* "account": "00******42",
* "source_currency": "NGN",
* "arrival_currency": "NGN", // fixed value: NGN
* "fee_bear": "merchant", // should be one of merchant, beneficiary
* "method": "BANKTRANSFER", // fixed value: BANKTRANSFER
* "amount": "100.00",
* "notify_url": "https://notify.url",
* "custom_code" : "custom_code9982674851738108",
* "additional_remark": "pagsmile payout test remark",
* "country": "NGA" // fixed value: NGA
}
'
Last updated
Was this helpful?