Carteira

Onde criar um payout por carteira na Colômbia.

Criar um payout por carteira na Colômbia

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

Este endpoint permite que você envie um pagamento por Carteira 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
document_id	string	Beneficiary document id
channel*	string	Valor fixo: Tpaga
phone	string	Telefone do beneficiário - Max.15 -
email	string	E-mail do beneficiário - Max.64 -
document_type	string	Beneficiary document type
name	string	Nome do beneficiário - Min.5 Max.100 -
account*	string	Beneficiary Tpaga account. - Max.11 -
method*	string	Valor fixo: WALLET
account_type*	string	Valor fixo: PHONE
custom_code*	string	Merchant's order id - 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 -
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
additional_remark*	string	Observação adicional - Max: 40 chars-
country*	string	País do Beneficiário. - Valor fixo: COL -
amount_type	string	Especifique o valor fixo para comerciante ou beneficiário - Um de: source_amount, arrival_amount(default)-

200: OK enviado com sucesso

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

400: Bad Request bad request

{
    "code": 4001000,
    "msg": "invalid parameter",
    "time": 1637224716,
    "data": {}
}

401: Unauthorized não autorizado

{
    "code": 4004003,
    "msg": "permission denied",
    "time": 1637224716,
    "data": {}
}

500: Internal Server Error erro no servidor

{
    "code": 5001000,
    "msg": "system error",
    "time": 1637224716,
    "data": {}
}

500: Internal Server Error taxa não configurada

{
    "code": 5001003,
    "msg": "fee not configured",
    "time": 1637224716,
    "data": {
        ... ...
    }
}

500: Internal Server Error taxa não configurada

{
    "code": 5001102,
    "msg": "balance insufficient",
    "time": 1637224716,
    "data": {
        ... ...
    }
}

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",
      "email" : "g******[e-mail]",
    * "account" : "+57317****412",
    * "account_type" : "PHONE",
      "document_id" : "************",
      "document_type" : "***",
    * "method" : "WALLET",
    * "channel" : "Tpaga",
    * "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.