Initiate a Payment (Bre-B)

Overview

This endpoint allows you to initiate a Bre-B payment within the Passport API. A successful request processes the payment and returns the transaction details, including status and recipient information.

Endpoint Details

Definition	Description
Endpoint	https://api.paas.sandbox.co.passportfintech.com/v1/payments/breb
Method	POST
Headers	Content-Type: application/json, Authorization
Authentication	Access Token (Bearer Token)

Request Body

Parameter	Type	Constraints	Required	Description
account_id	String		Yes	The unique identifier of the account from which the payment will be made.
resolution_id	String		Yes	The unique identifier from the resolution of the Bre-B recipient for sending the Payment.
amount	Object		Yes	Defines the value and currency of the transaction.
value	String		Yes	The amount to be transferred.
currency	String	ENUM: `COP`	Yes	The currency of the transaction.
display_name	String		No	The parameter is utilized to display the naming details from the sender to the receiver. In the object `owner`, the response will exhibit the following structure: "name from display_name (name of merchant)" `"Gustavo Munoz (Merchant I9TOS)"`

Note

For notation amount.value, it stats the object.field name.

Bre-B transaction limit is 11.5 million COP.

Example Request

curl --location --request POST'https://api.paas.sandbox.co.passportfintech.com/v1/payments/breb' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --data '{ "account_id": "1b095dbd-7d4b-46d5-8807-1d636482e48a", "resolution_id": "039e06fb-5a26-4b8f-9846-023fe8ccc283", "amount": { "value": "1.00", "currency": "COP" }, "display_name" : "Gustavo Munoz" }'

Response Body

HTTP Status Code: 200 OK.
Returns the newly created payment and its associated metadata.

Example of Response

{ "status": "PROCESSING", "account_id": "1b095dbd-7d4b-46d5-8807-1d636482e48a", "type": "BREB", "updated_at": "2026-03-09T23:02:06.875Z", "id": "f8d4f5a0-2f35-4f27-a963-6d428f7b8842", "created_at": "2026-03-09T23:02:06.875Z", "resolution_id": "039e06fb-5a26-4b8f-9846-023fe8ccc283", "amount": { "currency": "COP", "value": "1.00" }, "sender": { "owner": { "name": "Gustavo Munoz (Merchant I9TOS)", "identification_type": "NIT", "identification_number": "123450016", "type": "BUSINESS" }, "account": { "account_type": "ORDINARY", "account_number": "866000018" }, "participant": { "identification_number": "890203088" } }, "receiver": { "owner": { "name": "Mi Empresa SAS", "identification_type": "NIT", "identification_number": "123450008", "type": "BUSINESS" }, "key": { "key_type": "ALPHA", "key_value": "@X0LMIDNAGJY6L13LDLZL" }, "account": { "account_type": "ORDINARY", "account_number": "866000012" }, "participant": { "identification_number": "890203088" } }, "direction": "OUTBOUND", "end_to_end_identification": "20260309890203088VIS502154946670531" }

Important

The payment status will first be PENDING. Once the payment is processed, it will change to SETTLED. You can use the Webhooks to check the payment statuses.
The id you get back is the payment_id, which you will use in other endpoints.
Make sure to re-use the resolution_id when you are re-trying a payment. This is crucial as we guarantee that only one payment will be created with the same resolution_id. In other words, it acts as an idempotency key, ensuring that duplicate payments are not processed.

Common Errors and Handling

HTTP Status Code	Meaning	Description
400 Bad Request	Invalid Data	Required fields are missing or contain incorrect values.
401 Unauthorized	Expired Token	The access token is invalid or has expired.
403 Forbidden	Access Denied	The request is not authorized to create a payment.
500 Internal Server Error	Server Error	An unexpected error occurred while processing the payment.

Best Practices

Ensure the account_id and recipient_id are correct before making the request.
Monitor the payment status (PENDING, SETTLED, etc.) to track progress.
Implement error handling to manage failed or delayed payments.

Last updated on