Bre-B

How to use Bre-B to submit a payout in Colombia.

Submit a payout by Bre-B in Colombia

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

This endpoint allows you to submit a payout by Bre-B 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.
account*	string	Account - Support Email, Phone, Document Id and Alias, Max 64 -
document_id*	string	Beneficiary document id
document_type*	string	Beneficiary document type, should be one of CC, CE, PEP, NIT, TI, PAS
method*	string	Fixed Value: Bre-B
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 1000, Max 11,550,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

200: OK success

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

400: Bad Request bad request

401: Unauthorized unautorized

500: Internal Server Error fee not configured

500: Internal Server Error balance insufficient

500: Internal Server Error system error

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": "SU**********EZ",
    * "account": "su**********com",
    * "document_id": "10******58",
    * "document_type": "CC",
    * "method": "Bre-B",
    * "custom_code": "custom_code9982674851738108",
    * "fee_bear": "merchant",
    * "amount": "1000", //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"
}'

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	Explanation	Length	Type
CC	Cédula de Ciudadanía	Between 6 to 10	numeric
CE	Cédula de Extranjería	up to 12	characters
PEP	Permiso Especial de Permanencia	up to 15	numeric
TI	Tarjeta de Identidad	6 to 10	numeric
NIT	Número de Identificación Tributaria	9 to 10	numeric
PAS	Pasaporte	up to 9	numeric