# BankTransfer
How to use Bank Transfer to submit a payout in Brazil.
# Post
https://sandbox.transfersmile.com/api/payout
# Submit a payout by Bank Transfer in Brazil
This endpoint allows you to submit a payout by Bank Transfer in Brazil.
# Parameters
# Header
Content-Type* | string | application/json; chartset=UTF-8 |
AppId* | string | Your App ID in payout platform |
Authorization* | string | SHA256($sorted_params + $app_key) |
# Body
name* | string | Beneficiary's name - Length must between 5 and 100 - |
phone | string | Beneficiary's phone - 0 ~ 15 digits - |
string | Beneficiary's email | |
document_id* | string | Beneficiary's personal identification number |
document_type* | string | Beneficiary's personal identification type - One of: CPF, CNPJ - |
bank_code* | string | Bank Code in Brazil, see** bank list ** |
branch* | string | Bank Branch Code |
account* | string | Beneficiary's Bank Account - 4 ~ 12 digits - |
account_type* | string | Beneficiary's Account Type - One of: SAVINGS, CHECKING - |
account_digit | string | Account Digit |
branch_digit | string | Branch digit |
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* | string | Payout Amount, 2 decimal numbers - Min 0.50, Max 1,000,000 - |
amount_type | string | Specify the amount value is fixed for merchant or beneficiary - One of: source_amount, arrival_amount(default) - |
source_currency* | string | Merchant Account Currency - One of: USD, EUR, GBP, BRL - |
arrival_currency* | string | Fixed value: BRL |
notify_url* | string | Where transfersmile will send notification to. |
additional_remark* | string | Descriptor on the user's bank bill - Max. 40 chars - |
country* | string | BRA for Brazil |
# Responses
200: OK | submit successfully |
{
"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"
}
}
400: Bad Request | order already existed |
{
"code": 4001010,
"msg": "order already existed",
"time": 1628580940,
"data": {}
}
401: Unauthorized | unauthorized |
{
"code": 4004003,
"msg": "permission denied",
"time": 1637224716,
"data": {
... ...
}
}
500: Internal Server Error | fee not configured |
{
"code": 5001003,
"msg": "fee not configured",
"time": 1637224716,
"data": {
... ...
}
}
500: Internal Server Error | balance insufficient |
{
"code": 5001102,
"msg": "balance insufficient",
"time": 1637224716,
"data": {
... ...
}
}
500: Internal Server Error | system error |
{
"code": 5001000,
"msg": "system error",
"time": 1637224716,
"data": {
... ...
}
}
# 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",
"phone": "",
"email": "[email protected]",
* "bank_code": "001",
* "account_type": "CHECKING", // should be one of SAVINGS, CHECKING
* "account": "6***8",
"account_digit": "4",
* "branch": "0**8",
* "document_id": "12*******91",
* "document_type": "CPF", // should be one of CPF, CNPJ
* "source_currency": "BRL",
* "arrival_currency": "BRL", // fixed value: BRL
* "fee_bear": "merchant", // should be one of merchant, beneficiary
* "method": "BANKTRANSFER", // fixed value: BANKTRANSFER
* "amount": "1.80",
* "notify_url": "https://notify.url",
* "custom_code" : "custom_code9982674851738108",
* "additional_remark": "transfersmile payout test remark",
* "country": "BRA" // fixed value: BRA
}
TIP
Note: 94FAC*****************68548 is transfersmile's test App ID for sandbox, and d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302 is authorization token associated with the test App ID.
# Example of Document
Document Type | Document ID | Descritpion |
---|---|---|
CPF | 22*******99 | 11 digits |
CNPJ | 23**********31 | 14 digits |
# Example of Account
X --> Numeric character
D --> Alphanumeric character
Branch Code | Account | Description |
---|---|---|
XXXX | XXXX - XXXXXXXXXXXXX | 4 - 18 digits |
XXXXD | XXXX - XXXXXXXXXXXXX | 4 - 18 digits |
XXXXDD | XXXX - XXXXXXXXXXXXX | 4 - 18 digits |
# Third-party CPF/CNPJ Validator
← Pix Notification →