Wallet

Where to submit a payout by Wallet in Colombia.

Submit a payout by Wallet in Colombia

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

This endpoint allows you to submit a payout by e-Wallet in Colombia.

Headers

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

Request Body

Name	Type	Description
document_id	string	Beneficiary document id
channel*	string	Tpaga or Nequi
phone	string	Beneficiary's phone. - 0 ~ 15 digits -
email	string	Beneficiary's email - Max.64 -
document_type	string	Beneficiary document type
name	string	Beneficiary's name - Min.5 Max.100 -
account*	string	Beneficiary Tpaga account. - 11 ~ 14 chars -
method*	string	Fixed Value: WALLET
account_type*	string	Fixed Value: PHONE
custom_code*	string	Merchant's order id - Max. 50 -
fee_bear*	string	One of [beneficiary | merchant]
amount*	string	Payout Amount, should be an Integer. - Tpage: Min 1 ~ Max 2,000,000; Nequi: Min 1,000 ~ Max 2,000,000 -
source_currency*	string	Merchant's account currency - supported: USD, GBP, EUR, COP -
arrival_currency*	string	Beneficiary's account currency. - Fixed Value: COP -
notify_url*	string	Where pagsmile will callback to
additional_remark*	string	Additional Remark - Max length: 40 -
country*	string	Beneficiary's Country - Fixed Value: COL -
amount_type	string	Specify the amount value is fixed for merchant or beneficiary - One of: source_amount, arrival_amount(default) -

200: OK submit successfully

{
    "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 unauthorized

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

500: Internal Server Error server error

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

500: Internal Server Error fee not configured

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

500: Internal Server Error balance insufficient

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

Example

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" : "GUILHERME ****** SOUZA",
      "phone" : "468****068",
      "email" : "g******[e-mail]",
    * "account" : "+57317****412",
    * "account_type" : "PHONE",
      "document_id" : "************",
      "document_type" : "***",
    * "method" : "WALLET",
    * "channel" : "Tpaga", //Choose Tpaga or Nequi
    * "custom_code" : "custom_code9982674851738108",
    * "fee_bear" : "merchant",
    * "amount" : "100", //Amount should be an integer, like 1.00 is not available.
    * "source_currency" : "COP",
    * "arrival_currency" : "COP",
    * "notify_url" : "https://notify.url",
    * "additional_remark" : "pagsmile payout test",
    * "country": "COL"
}'

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

In sandbox environment, please use [phone] as Tpaga account for testing Failed payout, any other Tpaga account will be successful.