Bank Account - COP

Introduction

This section covers the COP (Colombian Peso) utility endpoint used to look up information about a Bre-B key before referencing it in a ticket or registering it on a beneficiary.

For sending COP via Bre-B you can either:

• Register a beneficiary with a breBKey (see Beneficiaries Bank Accounts > Bank Guide COP) and reference it by id in the ticket, or
• Pass the breBKey inline in the ticket payload — the key is validated automatically at ticket creation time.

The endpoint below lets you validate a key on demand (e.g., to show the holder name to your end-user before they confirm the operation).

Get Bre-B Info

The Bre-B Info endpoint validates a Bre-B key against the Bre-B network and returns the linked holder information when the key is registered. Mirrors the PIX Info pattern.

Parameters

Field	Type	Description
breBKey	string	The Bre-B key you would like to look up.

HTTP GET Request

https://api.sandbox.avenia.io:10952/v2/account/bank-accounts/cop/bre-b-info

cURL Example:

curl -X GET "https://api.sandbox.avenia.io:10952/v2/account/bank-accounts/cop/bre-b-info?breBKey=@CBW0ZWQT6" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

JSON Response

{
  "holderName": "San*** Te****",
  "holderIdNumber": "*****1234"
}

Response Fields

Field	Type	Description
holderName	string	Masked holder name.
holderIdNumber	string	Masked holder document number.

Errors

Status	When
404	The key is not registered on the Bre-B network.
400	breBKey query parameter is missing or malformed.

Conclusion

You now have the necessary understanding to validate a Bre-B key before consuming it in a ticket or beneficiary cadastro within the Avenia API.