TransfersmileTransfersmile
  • EN
  • PT
  • ES
  • EN
  • PT
  • ES
  • Introduction
  • Payin API
    • Environments
    • Direct integration
      • Brazil
        • Credit Card
        • Pix
        • Lottery
        • Boleto
        • Deposit Express
        • Wallet
    • Notification
      • Security
    • Payin Detail
    • Refund
    • Plug-in & Tools
      • transfersmile JavaScript
      • transfersmile SDK
      • Get CreditCard Token
      • Supported Bank List Query
      • Installment Detail Query
    • Data
      • Payment Method
      • Data for test (Sandbox)
      • Payin Status
      • Icon of methods
    • API Code
  • Payout API
    • Environments
    • Security
    • Submit a payout
      • transfersmile Wallet
        • WebView Example
        • H5 Authorization
        • Native App Authorization
        • Send Prizes
      • Brazil
        • Pix
        • BankTransfer
    • Notification
    • Payout DryRun
    • Account Balance
    • Payout Status
    • Payout List
    • Payout Detail
    • Payment Method
    • Data for test
    • Bank Code
      • Bank in Brazil
    • API Code

transfersmile Wallet

How to use transfersmile Wallet to submit a payout.

  • H5 Authorization

  • Native App Authorization

  • Send Prizes

Environment

EnvironmentAPI
sandboxhttps://sandbox.transfersmile.com/api/payout
producthttps://api.transfersmile.com/api/payout

HTTP Method

POST

HTTP Header

HeaderTypeRequiredDescription
Content-TypeStringYesapplication/json; charset=UTF-8
AppIdStringYesYour App ID in payout platform
AuthorizationStringYesSHA256($sorted_params + $app_key)

HTTP Body(Only JSON Supported)

ParameterTypeRequiredDescription
nameStringNoBeneficiary's name
Min.5 Max.100
phoneStringNoBeneficiary's phone
- Max.15 -
emailStringNoBeneficiary's email
accountStringYestransfersmile Wallet account
account_typeStringYesFixed Value: UUID
methodStringYesFixed Value: WALLET
channelStringYesFixed Value: transfersmile
amountNumeric StringYesPayout amount
- Min 0.01, Max 50,000 -
amount_typeStringNoSpecify the amount value is fixed for merchant or beneficiary:
source_amount, arrival_amount(default)
fee_bearStringYesOne of [beneficiary
custom_codeStringYesMerchant's order id
- Max.50 -
source_currencyStringYesMerchant's account currency, supported: USD, GBP, EUR
arrival_currencyStringYesBeneficiary's account currency, BRL or MXN
notify_urlStringYesWhere transfersmile will callback to
additional_remarkStringYesPayout Additional Remark, Max length: 40
countryStringYesCountry code, BRA or MEX

Request Example

// test demo by curl
curl --location --request POST 'https://sandbox.transfersmile.com/api/payout' \
--header 'AppId: 94FAC**********************68548' \
--header 'Authorization: d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302' \
--header 'Content-Type: application/json' \
--data-raw '{
      "name": "Alan **** **** Santana",
      "email": "[email protected]",
    * "account": "f341************************0844",
    * "account_type": "UUID",
    * "amount": "10.00",
    * "source_currency": "USD",
    * "arrival_currency": "BRL",
    * "custom_code": "custom_code_pwallet_10010", // merchant order id
    * "fee_bear": "merchant",
    * "method": "WALLET",
    * "channel": "transfersmile",
    * "notify_url": "https://sandbox.transfersmile.com/api/notify/demo",
    * "additional_remark": "Pagsmaile wallet test",
    * "country": "BRA"
}'

Tip

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

HTTP Response

// success
{
    "code": 200,
    "msg": "success",
    "time": 1628580845,
    "data": {
        "id": "TS202108100734054iRiUZFPXfQWB", // transfersmile payout id
        "custom_code": "custom_code9982674851738108", // merchant order id
        "arrival_amount": "100",
        "arrival_currency": "BRL",
        "source_amount": "0.07",
        "source_currency": "USD",
        "status": "IN_PROCESSING"
    }
}
// bad request
{
    "code": 4001000,
    "msg": "invalid parameter",
    "time": 1637224716,
    "data": {
        ... ...
    }
}
// persmission denied
{
    "code": 4004003,
    "msg": "permission denied",
    "time": 1637224716,
    "data": {
        ... ...
    }
}
// balance insufficient
// balance insufficient
{
    "code": 5001102,
    "msg": "balance insufficient",
    "time": 1637224716,
    "data": {
        ... ...
    }
}
// system error
{
    "code": 5001000,
    "msg": "system error",
    "time": 1637224716,
    "data": {
        ... ...
    }
}

Supported Countries

CountryCountry CodeCurrency
BrazilBRABRL
MexicoMEXMXN

​

Next
Brazil