Submit a payout

How to submit a payout use transfersmile Payout API.

Post

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

Request a payout

This is the base method used to request a payout. Please note each country may have its own additional requirements and will have its own payment schedules, see below for more detailed examples.

Parameters

Content-Type*stringapplication/json; chartset=UTF-8
AppId*stringYour App ID in payout platform
Authorization*stringSHA256($sorted_params + $merchant_key)

Body

name*stringBeneficiary's name
- Max. 100 chars -
phonestringBeneficiary's phone
emailstringBeneficiary's email
account*stringBeneficiary's bank account
account_type*stringBeneficiary's bank account type
document_id*stringBeneficiary's personal identification number
document_type*stringBeneficiary's personal identification type
method*stringPayout method
channel*stringPayout channel
custom_code*stringMerchant Payout Id
- Max. 50 chars -
fee_bear*stringProcessing fee charges to merchant or beneficiary.
- One of: merchant beneficiary -
amount*stringPayout Amount.
- Max. 2 decimal numbers -
source_currency*stringMerchant Account Currency
- Length: 3 chars -
arrival_currency*stringLocal currency
- Length: 3 chars -
notify_url*stringWhere transfersmile will send Notification to.
- Max. 128 chars -
additional_remark*stringAdditional Remark
- Max. 40(MEX) or 80(BRA) chars -
country*stringThe user's country. ISO 3166-1 alpha-3 code
- Length: 3 chars -

Responses

200Request 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"
    }
}

Countries

  • ​transfersmile Wallet ​

    • More detailed examples for submitting a payout using transfersmile Wallet.

  • ​Brazil ​

    • More detailed examples for submitting a payout in Brazil.

​