Transferência bancária

Como usar a Transferência Bancária para criar um payout na Colômbia.

Criar um payout por transferência bancária na Colômbia

POST https://sandbox.transfersmile.com /api/payout

Este endpoint permite que você envie um payout por transferência bancária na Colômbia.

Headers

Name	Type	Description
Content-Type*	string	application/json; charset=UTF-8
AppId*	string	Seu App ID na plataforma de payout
Authorization*	string	SHA256($sorted_params + $app_key)

Request Body

Name	Type	Description
name*	string	Nome do beneficiário - entre 5 e 100 chars -
phone*	string	Telefone do beneficiário
email*	string	E-mail do beneficiário
bank_code*	string	Código do banco, ver lista de bancos
account*	string	Conta, comprimento máximo é 20
account_type*	string	Deve ser um de CHECKING, SAVINGS, VISTA, RUT, SALARY.
document_id*	string	Documento de identificação do beneficiário
document_type*	string	Tipo de documento beneficiário, deve ser do CC, CE, PEP
method*	string	Valor fixo: BankTransfer
custom_code*	string	ID do pedido do merchant - Max.50 -
fee_bear*	string	Um de [beneficiary | merchant]
amount*	string	O valor do Payout , deve ser um número inteiro - Min 1, Max 2,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, GBP, EUR -
arrival_currency*	string	Moeda da conta do beneficiário. - Valor fixo: COP -
notify_url*	string	Onde a pagsmile vai enviar o callback
additionl_remark*	string	Onde a pagsmile vai enviar o callback - Max: 40 chars-
country*	string	Valor fixo: COL, para Colômbia

200: OK sucesso

{
    "code": 200,
    "msg": "success",
    "time": 1628580845,
    "data": {
        "id": "TS202108100734054iRiUZFPXfQBC",
        "custom_code": "custom_code9982674851738108",
        "arrival_amount": "100",
        "arrival_currency": "COL",
        "source_amount": "0.07",
        "source_currency": "USD",
        "status": "IN_PROCESSING"
    }
}

400: Bad Request bad request

{
    "code": 4001000,
    "msg": "invalid parameter",
    "time": 1637224716,
    "data": {
        "err": "error detail message"
    }
}

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": {
        "err": "error detail message"
    }
}

Exemplo

curl --location --request POST 'http://sandbox.transfersmile.com/api/payout' \
--header 'AppId: 94FAC**********************68548' \
--header 'Authorization: d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302' \
--header 'Content-Type: application/json' \
--data-raw '{
    * "name" : "GUILHERME ****** SOUZA",
    * "phone" : "468****068", // phone is required
    * "email" : "g******[e-mail]", // email is required
    * "bank_code": "007", // Bancolombia
    * "account" : "00219400254640654321", // just for test in sandbox
    * "account_type" : "CHECKING",
    * "document_id" : "123456789", // just for test in sandbox, don't use this in production.
    * "document_type" : "CC",
    * "method" : "BankTransfer",
    * "custom_code" : "custom_code9982674851738108",
    * "fee_bear" : "merchant",
    * "amount" : "100", //Amount should be an integer, like 1.00 is not available.
    * "source_currency" : "USD",
    * "arrival_currency" : "COP",
    * "notify_url" : "https://notify.url",
    * "additional_remark" : "pagsmile payout test",
    * "country": "COL"
}'

Nota: 94FAC**********************68548 é o App Id de teste Pagsmile para o ambiente de sandbox, e d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302 é o token de autorização associado ao App Id de teste.

Tipo de documento

Name	Comprimento	Tipo
CC	Entre 6 e 10	numeric
CE	até 12	characters
PEP	até 15	characters