# Transferência bancária
Como utilizar a Transferência Bancária para criar um payout no Brasil.
# Post
https://sandbox.transfersmile.com/api/payout
# Criar um payout por transferência bancária no Brasil
Este endpoint permite que você apresente um pagamento por transferência bancária no Brasil.
# Parameters
# Header
Content-Type* | string | application/json; chartset=UTF-8 |
AppId* | string | Seu App ID na plataforma de payout |
Authorization* | string | SHA256($sorted_params + $app_key) |
# Body
name* | string | Nome do beneficiário - entre 5 e 100 chars - |
phone | string | Telefone do beneficiário |
string | E-mail do beneficiário | |
document_id* | string | Número de identificação pessoal do beneficiário |
document_type* | string | Tipo de identificação pessoal do beneficiário - CPF ou CNPJ - |
bank_code* | string | Código do Banco no Brasil, ** lista de bancos ** |
branch* | string | Código da agência bancária |
account* | string | Conta bancária do beneficiário |
account_type* | string | Tipo de conta bancária do beneficiário - SAVINGS ou CHECKING - |
account_digit | string | Dígito da conta |
branch_digit | string | Dígito da agência |
method* | string | Valor fixo: BANKTRANSFER |
custom_code* | string | ID de Payout do merchant - Max. 50 chars - |
fee_bear* | string | Taxas de processamento para o comerciante ou beneficiário. - Um dos seguintes: merchant, beneficiary - |
amount* | string | Valor do Payout, 2 números decimais - Min 0.50, Max 1,000,000 - |
amount_type | string | Especifique o valor fixo para comerciante ou beneficiário - Um de: source_amount, arrival_amount(default) - |
source_currency* | string | Moeda da conta do Merchant - USD, EUR, GBP, BRL - |
arrival_currency* | string | Valor fixo: BRL |
notify_url* | string | Para onde a transfersmile enviará a notificação. |
additional_remark* | string | Descrição na fatura bancária do usuário - Max. 40 chars - |
country* | string | BRA para Brasil |
# Responses
200: OK | enviado com sucesso |
{
"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 | ordem já existe |
{
"code": 4001010,
"msg": "order already existed",
"time": 1628580940,
"data": {}
}
401: Unauthorized | não autorizado |
{
"code": 4004003,
"msg": "permission denied",
"time": 1637224716,
"data": {
... ...
}
}
500: Internal Server Error | taxa não configurada |
{
"code": 5001003,
"msg": "fee not configured",
"time": 1637224716,
"data": {
... ...
}
}
500: Internal Server Error | saldo insuficiente |
{
"code": 5001102,
"msg": "balance insufficient",
"time": 1637224716,
"data": {
... ...
}
}
500: Internal Server Error | erro no servidor |
{
"code": 5001000,
"msg": "system error",
"time": 1637224716,
"data": {
... ...
}
}
# Exemplo
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
Importante: 94FAC*****************68548 é o App Id de teste da transfersmile para o ambiente sandbox, e d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302 é o token de autorização associado ao App Id de teste.
← Pix Notificação →