# Submit a payout
How to submit a payout use transfersmile Payout API.
# Post
https://sandbox.transfersmile.com/api/payout
# Request a payout
This is the base method used to request a payout. Please note each country may have its own additional requirements and will have its own payment schedules, see below for more detailed examples.
# Parameters
# Header
Content-Type* | string | application/json; chartset=UTF-8 |
AppId* | string | Your App ID in payout platform |
Authorization* | string | SHA256($sorted_params + $merchant_key) |
# Body
name* | string | Beneficiary's name - Max. 100 chars - |
phone | string | Beneficiary's phone |
string | Beneficiary's email | |
account* | string | Beneficiary's bank account |
account_type* | string | Beneficiary's bank account type |
document_id* | string | Beneficiary's personal identification number |
document_type* | string | Beneficiary's personal identification type |
method* | string | Payout method |
channel* | string | Payout channel |
custom_code* | string | Merchant Payout Id - Max. 50 chars - |
fee_bear* | string | Processing fee charges to merchant or beneficiary. - One of: merchant beneficiary - |
amount* | string | Payout Amount. - Max. 2 decimal numbers - |
source_currency* | string | Merchant Account Currency - Length: 3 chars - |
arrival_currency* | string | Local currency - Length: 3 chars - |
notify_url* | string | Where transfersmile will send Notification to. - Max. 128 chars - |
additional_remark* | string | Additional Remark - Max. 40(MEX) or 80(BRA) chars - |
country* | string | The user's country. ISO 3166-1 alpha-3 code - Length: 3 chars - |
# Responses
200 | Request ok |
{
"code": 200,
"msg": "success",
"time": 1628580845,
"data": {
"id": "S202108100734054iRiUZFPXfQM",
"custom_code": "custom_code9982674851738108",
"arrival_amount": "0.51",
"arrival_currency": "MXN",
"source_amount": "0.07",
"source_currency": "USD",
"status": "IN_PROCESSING"
}
}
# Countries
-
- More detailed examples for submitting a payout using transfersmile Wallet.
Brazil
- More detailed examples for submitting a payout in Brazil.