Transfiya

Where to submit a payout by Transfiya in Colombia.

Submit a payout by Transfiya in Colombia

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

This endpoint allows you to submit a payout by Transfiya 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
account*	String	Beneficiary's account - 12 ~ 14 digits -
email	String	Beneficiary's email
phone	String	Beneficiary's phone - 0 ~ 15 digits -
document_type*	String	Beneficiary document type, should be one of CC, CE, PEP
document_id*	String	Beneficiary document id
account_type*	String	Fixed Value: PHONE
amount*	String	Payout amount, should be an Integer. - Min 1,000, Max 10,000,000 COP per transaction -
fee_bear*	String	One of [beneficiary | merchant]
custom_code*	String	Merchant's order id - Max.50 -
method*	String	Fixed Value: Transfiya
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

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

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" : "57012345678910", // just for test in sandbox
    * "account_type" : "PHONE",
    * "document_id" : "123456789", // just for test in sandbox, don't use this in production.
    * "document_type" : "CC",
    * "method" : "Transfiya",
    * "custom_code" : "your_order_id", // merchant order id
    * "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 571111111111 as TransfiYa account, and PHONE as account_type for testing REJECTED payout, any other TransfiYa account will be success (PAID).

Document Type

Name	Length	Type
CC	Between 6 to 10	numeric
CE	up to 12	characters
PEP	up to 15	numeric

Example of Account

Account Type	Account	Description
PHONE	57012345678910	numeric, always start with 57

Supported Banks and Wallets

Bancolombia, DAVIVIENDA, Banco de Bogotá, Banco Caja Social, Banco AV Villas, Banco Ser finanza, Itau, Banco Cooperativo Coop Central, Banco Finandina, confiar coop, DAVIplata, NEQUI, MOVII, dale!