# Criar um payout
Como enviar um payout usando a API Payout da transfersmile.
# Post
https://sandbox.transfersmile.com/api/payout
# Solicitar um payout
Este é o método básico utilizado para solicitar um payout. Observe que cada país pode ter suas próprias exigências adicionais e terá seus próprios cronogramas de pagamento, veja abaixo exemplos mais detalhados.
# Parameters
# Header
Content-Type* | string | application/json; chartset=UTF-8 |
MerchantId* | string | Sua ID de merchant na plataforma de payout |
Authorization* | string | SHA256($sorted_params + $merchant_key) |
# Body
name* | string | Nome do beneficiário - Max. 100 chars - |
phone | string | Telefone do beneficiário |
string | E-mail do beneficiário | |
account* | string | Conta bancária do beneficiário |
account_type* | string | Tipo de conta bancária 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 |
method* | string | Método de Payout |
channel* | string | Canal de Payout |
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 - Max. 2 números decimais - |
source_currency* | string | Moeda da Conta Mercante - Comprimento: 3 caracteres - |
arrival_currency* | string | Moeda local - Comprimento: 3 chars - |
notify_url* | string | Para onde a transfersmile enviará a Notificação. - Max. 128 chars - |
additional_remark* | string | Observação adicional - Max. 40(MEX) or 80(BRA) chars - |
country* | string | O país do usuário. Código ISO 3166-1 alfa-3 - Comprimento: 3 caracteres - |
# 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"
}
}
# Países
-
- Exemplos mais detalhados para enviar um payout usando a Carteira transfersmile.
Brasil
- Exemplos mais detalhados para enviar um payout no Brasil.