# BankTransfer ## 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

- Max 15, valid phone -

| | email\* | string |

Beneficiary 's email
- Max 64, valid email -

| | bank\_code\* | string | Bank code, see [***bank list​***](/payout/banklist/bank-in-colombia.md) | | account\* | string |

Account

- 8 \~ 20 digits -

| | account\_type\* | string | Should be one of CHECKING, SAVINGS, ELECTRONIC DEPOSIT | | document\_id\* | string | Beneficiary document id | | document\_type\* | string | Beneficiary [***document type***](#account-type), should be one of CC, CE, NIT, NUIP, PAS, PEP, PPT, TI | | method\* | string | Fixed Value: BANKTRANSFER | | custom\_code\* | string |

Merchant's order id

- Max.50 -

| | fee\_bear\* | string |

All fees charge to merchant or beneficiary
- One of: merchant, beneficiary -

| | amount\* | string |

Payout amount, should be an Integer.

- Min 1,000, 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 | | additional\_remark\* | string |

Additional Remark
- Max Length: 40 -

| | country\* | string | Fixed value: COL, for Colombia | {% tabs %} {% tab title="200: OK success" %} ```javascript { "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" } } ``` {% endtab %} {% tab title="400: Bad Request bad request" %} ```javascript { "code": 4001000, "msg": "invalid parameter", "time": 1637224716, "data": { "err": "error detail message" } } ``` {% endtab %} {% tab title="401: Unauthorized unautorized" %} ```javascript { "code": 4004003, "msg": "permission denied", "time": 1637224716, "data": { ... ... } } ``` {% endtab %} {% tab title="500: Internal Server Error fee not configured" %} ```javascript { "code": 5001003, "msg": "fee not configured", "time": 1637224716, "data": { ... ... } } ``` {% endtab %} {% tab title="500: Internal Server Error balance insufficient" %} ```javascript { "code": 5001102, "msg": "balance insufficient", "time": 1637224716, "data": { ... ... } } ``` {% endtab %} {% tab title="500: Internal Server Error system error" %} ```javascript { "code": 5001000, "msg": "system error", "time": 1637224716, "data": { "err": "error detail message" } } ``` {% endtab %} {% endtabs %} ## 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": "1007", // 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 must be an integer, the fraction is not supported (e.g. 100 or 100.00 is acceptable, but 100.01 is not) * "source_currency" : "COP", * "arrival_currency" : "COP", * "notify_url" : "https://notify.url", * "additional_remark" : "pagsmile payout test", * "country": "COL" }' ``` {% hint style="info" %} Note: ***94FAC\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*68548*** is Pagsmile's test App ID for sandbox, and ***d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302*** is authorization token associated with the test App ID. {% endhint %} ## Document Type | Name | Explanation | Length | Type | | ---- | --------------------------------------- | --------------- | ---------- | | CC | Cédula de Ciudadanía | Between 6 to 10 | numeric | | CE | Cédula de Extranjería | up to 12 | characters | | NIT | Número de Identificación Tributaria | 9 to 10 | numeric | | NUIP | Número Único de Identificación Personal | 10 | numeric | | PAS | Pasaporte | up to 9 | numeric | | PEP | Permiso Especial de Permanencia | up to 15 | numeric | | PPT | Permiso de Protección Temporal | up to 15 | characters | | TI | Tarjeta de Identidad | 6 to 10 | numeric | ## Example of Account | Account Type | Account | Description | | ------------------ | -------------------- | ------------- | | CHECKING | 1\*\*\*\*\*\*\*\*\*6 | 8 - 20 digits | | SAVINGS | 2\*\*\*\*\*\*\*\*\*8 | 8 - 20 digits | | ELECTRONIC DEPOSIT | 2\*\*\*\*\*\*\*\*\*8 | 8 - 20 digits | --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.pagsmile.com/payout/submit-a-payout/colombia/banktransfer.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.