BankTransfer

How to use BankTransfer to submit a payout in Colombia.

Submit a payout by Bank Transfer in Colombia

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

This endpoint allows you to submit a payout by BankTransfer 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

name*

string

Beneficiary's full name, must match the name on the document id. Length must between 5 and 100.

phone*

string

Beneficiary's phone

- 0 ~ 15 digits -

email*

string

Beneficiary 's email

bank_code*

string

Bank code, see bank list​

account*

string

Account

- 8 ~ 18 digits -

account_type*

string

Should be one of CHECKING, SAVINGS

document_id*

string

Beneficiary document id

document_type*

string

Beneficiary document type, should be one of CC, CE, PEP

method*

string

Fixed Value: BankTransfer

custom_code*

string

Merchant's order id

- Max.50 -

fee_bear*

string

One of [beneficiary | merchant]

amount*

string

Payout amount, should be an Integer.

- Min 1, Max 20,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

additionl_remark*

string

Additional Remark - Max Length: 40 -

country*

string

Fixed value: COL, for Colombia

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

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", // phone is required
    * "email" : "g******me@gmail.com", // email is required
    * "bank_code": "007", // Bancolombia
    * "account" : "002194002546406543", // just for test in sandbox
    * "account_type" : "CHECKING",
    * "document_id" : "123456789", // just for test in sandbox, don't use this in production.
    * "document_type" : "CC",
    * "method" : "BankTransfer",
    * "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.

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

CHECKING

1*********6

9 - 18 digits

SAVINGS

2*********8

9 - 18 digits

PreviousTransfiyaNextCosta Rica

Last updated