Payout DryRun

A simulation(dry run) for payout.

Uma simulação(dry run) para payout.

POST https://sandbox.transfersmile.com/api/payout/dry-run

Headers

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

Request Body

Name	Type	Description
source_currency*	String	Moeda da conta do Merchant - supported: USD, GBP, EUR -
arrival_currency*	String	BRL para BRA, MXN para MEX, USD para PayPal
amount*	String	String numérica, e.g. 10.00
fee_bear*	String	Um de [beneficiary, merchant]
method*	String	Método de Payout
channel	String	Payout Channel
country*	String	Países com suporte do PayPal. Outros devem ser um dos países [BRA, MEX].
timestamp*	Integer	unix timestamp, e.g. 1628512575

200: OK

{
    "code": 200,
    "msg": "success",
    "time": 1642076131,
    "data": {
        "fee": "0.2",
        "tax": "0",
        "amount": "10",
        "settlement_amount": "10",
        "arrival_currency": "USD",
        "arrival_amount": "10",
        "source_currency": "USD",
        "source_amount": "10.2",
        "exchange_rate": "1"
    }
}

First Tab

Note: The exchange rate is updated every minute.

400: Bad Request

{
    "code": 4001000,
    "msg": "invalid parameter",
    "time": 1642078510,
    "data": {
        "err": "request has expired"
    }
}

401: Unauthorized

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

Exemplo PIX

curl --location --request POST 'http://localhost:20021/api/payout/dry-run' \
--header 'AppId: 94FAC**********************68548' \
--header 'Authorization: d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302' \
--header 'Content-Type: application/json' \
--data-raw '{
      * "source_currency": "USD",
      * "arrival_currency": "BRL",
      * "amount": "10.00",
      * "fee_bear": "merchant",
      * "method": "PIX",
        "channel": "",
      * "country": "BRA",
      * "timestamp": 1642075807
}'

Exemplo SPEI

curl --location --request POST 'http://localhost:20021/api/payout/dry-run' \
--header 'MerchantId: 94FAC**********************68548' \
--header 'Authorization: d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302' \
--header 'Content-Type: application/json' \
--data-raw '{
      * "source_currency": "USD",
      * "arrival_currency": "MXN",
      * "amount": "10.00",
      * "fee_bear": "merchant",
      * "method": "SPEI",
        "channel": "",
      * "country": "MEX",
      * "timestamp": 1642075807
}'

Exemplo PayPal

curl --location --request POST 'http://localhost:20021/api/payout/dry-run' \
--header 'MerchantId: 94FAC**********************68548' \
--header 'Authorization: d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302' \
--header 'Content-Type: application/json' \
--data-raw '{
      * "source_currency": "USD",
      * "arrival_currency": "USD",
      * "amount": "10.00",
      * "fee_bear": "merchant",
      * "method": "WALLET",
      * "channel": "PayPal",
      * "country": "BRA",
      * "timestamp": 1642075807
}'

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.