Payout DryRun

A simulation(dry run) for payout.

A simulation(dry run) for payout.

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

Headers

Name	Type	Description
Content-Type*	String	application/json; chartset=UTF-8
AppId*	String	Your App ID in payout platform
Authorization*	String	SHA256($sorted_params + $app_key)

Request Body

Name	Type	Description
source_currency*	String	Merchant's account currency - supported: USD, GBP, EUR -
arrival_currency*	String	BRL for BRA, MXN for MEX, USD for PayPal
amount*	String	Numeric string, e.g. 10.00
fee_bear*	String	One of [beneficiary, merchant]
method*	String	Payout Method
channel	String	Payout Channel
country*	String	PayPal supported countries. Others must be one of [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"
    }
}

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": {}
}

Example PIX

curl --location --request POST 'https://sandbox.transfersmile.com/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
}'

Example SPEI

curl --location --request POST 'https://sandbox.transfersmile.com/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
}'

Example PayPal

curl --location --request POST 'https://sandbox.transfersmile.com/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
}'

Note: 94FAC**********************68548 is pagsmile's test merchant id for sandbox, and d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302 is authorization token associated with the test App ID.