Confirm Payment
Overview
This endpoint allows you to Confirm and submit a Bre-B payment to the Bre-B network. 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/confirm |
Method | POST |
Headers | Content-Type: application/json, Authorization |
Authentication | Access Token (Bearer Token) |
Request Body
Parameter | Type | Constraints | Required | Description |
---|---|---|---|---|
id | String | Yes | The unique identifier of the payment to be sent to the Bre-B Network. |
Example Request
6
6
curl --location 'https://api.paas-sandbox.co.passportfintech.com/v1/payments/breb/confirm' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
--data '{
"id":"11e32036-0bf3-4c8b-b873-3bc77e0a6322"
}'
Response Body
- HTTP Status Code: 200 OK.
Example of Response
14
14
{
"amount": {
"value": "100000",
"currency": "COP"
},
"account_id": "7ece7ff4-3dd4-4c27-937e-c32903940465",
"updated_at": "2025-09-22T15:14:38.790Z",
"direction": "OUTGOING",
"reference": "Dispersion a merchant ABC",
"id": "11e32036-0bf3-4c8b-b873-3bc77e0a6322",
"breb_recipient_id": "0f7d4398-5fbd-4889-93ed-37e4ee20534d",
"created_at": "2025-09-22T15:14:38.790Z",
"status": "PENDING"
}
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.
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
id
of the document is correct before making the request. - Monitor the payment status (
PENDING
,SETTLED
, etc.) to track progress, via the Webhooks. - Implement error handling to manage failed or delayed payments.