Cashout

Where to submit a payout by Cashout in Colombia.

Submit a payout by Cashout in Colombia

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

This endpoint allows you to submit a payout by Cashout in Colombia.

Headers

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

Request Body

Name	Type	Description
name*	String	Beneficiary's name, length must between 5 and 100
phone*	String	Beneficiary's phone - 0 ~ 13 digits -
document_type*	String	Beneficiary document type, should be one of CC, CE, PEP, PPT, CV, TI, PAS
document_id*	String	Beneficiary document id
amount*	String	Payout amount, should be an Integer. - Min 20,000, Max 1,500,000 COP per transaction -
fee_bear*	String	One of [beneficiary | merchant]
custom_code*	String	Merchant's order id - Max.50 -
method*	String	Fixed Value: CASHOUT
country*	String	Fixed value: COL, for Colombia
arrival_currency*	String	Beneficiary's account currency. - Fixed Value: COP -
source_currency*	String	Merchant's account currency - supported: USD, GBP, EUR, COP -
amount_type	String	Specify the amount value is fixed for merchant or beneficiary - One of: source_amount, arrival_amount(default) -
additional_remark*	String	Additional Remark - Max Length: 40 -
notify_url*	String	Where pagsmile will callback to

Request 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" : "570123456789", 
    * "method" : "CASHOUT",
    * "custom_code" : "your_order_id", // merchant order id
    * "fee_bear" : "merchant",
    * "amount" : "30000", //Amount should be an integer, like 1.00 is not allowed.
    * "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.

Response Example

200: OK success

{
    "code": 200,
    "msg": "success",
    "time": 1628580845,
    "data": {
        "id": "TS202108100734054iRiUZFPXfQBC",
        "custom_code": "custom_code9982674851738108",
        "arrival_amount": "100",
        "arrival_currency": "COL",
        "source_amount": "0.07",
        "source_currency": "USD",
        "status": "IN_PROCESSING"
    }
}

400: Bad Request bad request

{
    "code": 4001000,
    "msg": "invalid parameter",
    "time": 1637224716,
    "data": {
        "err": "error detail message"
    }
}

401: Unauthorized unauthorized

{
    "code": 4004003,
    "msg": "permission denied",
    "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": {
        ... ...
    }
}

500: Internal Server Error system error

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

Payment Flow

After successfully creating a CASHOUT payout order, call the Payout Detail API to obtain the PIN code and validity period (in days) of that order.

It is recommended to notify the recipient of the following information via email, SMS, etc.:

1. Order amount

2. The recipient's information (name, ID number) corresponding to this order

3. The PIN code for this order

Remind the recipient to visit an Efecty service point within the valid period to withdraw the cash. When withdrawing, the recipient must bring the original ID card, as Efecty staff will need to verify the order amount, the recipient's identity, and the PIN before completing the order.

Document Type

Name	Description	Length	Type
CC	CEDULA DE CIUDADANIA	Between 6 to 10	numeric
CE	CEDULA DE EXTRANJERIA	up to 12	characters
PEP	PERMISO ESPECIAL DE PERMANENCIA	up to 15	numeric
PPT	PERMISO POR PROTECCION TEMPORAL	usually 15 digits	numeric
CV	CEDULA VENEZOLA
TI	TARJETA DE IDENTIDAD	6 to 10	numeric
PAS	PASAPORTE	up to 9	numeric