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
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
method*
string
Fixed Value: WALLET
channel*
string
Tpaga or Nequi
account_type*
string
Fixed Value: PHONE
account*
string
Beneficiary Tpaga or Nequi account.
- 11 ~ 14 chars -
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 -
amount_type
string
Specify the amount value is fixed for merchant or beneficiary - One of: source_amount, arrival_amount(default) -
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 -
name
string
Beneficiary's name
- Min.5 Max.100 -
string
Beneficiary's email
- Max.64 -
phone
string
Beneficiary's phone.
- 0 ~ 15 digits -
document_type
string
Beneficiary document type
document_id
string
Beneficiary document id
{
"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"
}
}
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******[email protected]",
* "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"
}'
In sandbox environment, please use +57311111111 as Tpaga account for testing Failed payout, any other Tpaga account will be successful.
Last updated
Was this helpful?