Payments / RailsBREB
BREB
Colombia interbank transfer rail. Used for pay-out in Colombia.
Rail overview
Use BREB for Colombian bank payouts when the recipient should receive funds through local bank infrastructure.
Conomy captures the withdrawal from an internal ACCOUNT and sends the payout instruction to the provider for bank processing.
Collect enough recipient bank data before capture so failures are validation issues, not operational exceptions.
Required fields
Section titled “Required fields”| Field | Type | Description |
|---|---|---|
type | string | Must be "BREB" |
currency | string | Must be "COP" |
breb.bankId | string | Recipient bank code |
breb.accountNumber | string | Recipient account number |
breb.customer.firstName | string | Recipient first name |
breb.customer.lastName | string | Recipient last name |
breb.customer.email | string | Recipient email |
Example
Section titled “Example”{ "type": "BREB", "currency": "COP", "breb": { "bankId": "1022", "accountNumber": "123456789", "customer": { "firstName": "Camila", "lastName": "Torres", "email": "camila@example.com" } }}Object
Section titled “Object”Bank identifier for the recipient's account.
Recipient's bank account number.
CHECKINGSAVINGSInformation on who pays the transaction
idstringUnique identifier for the internal service.
firstNamestringrequiredPayer's name
emailstringPayer's email
lastNamestringPayer's last name
phoneNumberstringPayer's phone number without prefix
phoneNumberPrefixstringPhone number prefix (e.g., +57)
documentTypestringDocumeny type of the entity (e.g., RUT, CURP, CURL). Go to the Supported Identity document types page for the complete list of supported values.
documentNumberstringThe document number associated with the documentType
addressobjectThe entity’s address information.
administrativeAreaLevel1stringThe first-level administrative division.
administrativeAreaLevel2stringThe second-level administrative division.
administrativeAreaLevel3stringThe third-level administrative division.
streetstringThe name of the street.
streetNumberstringThe street number.
optionalAddressstringAdditional address details.
countrystringCountry of operations for the entity, specified using the ISO 3166-1 alpha-3 standard (e.g., CHL, USA, MEX). Go to the countries page for the complete list of supported values.
zipcodestringZipcode f the address