Resolve a Recipient
Overview
This endpoint allows you to retrieve details of a specific Bre-B recipient within the Passport API using the recipient's unique ID. The response includes recipient key type, key value, and associated entity details.
Endpoint Details
| Definition | Description |
|---|---|
| Endpoint | https://api.paas.sandbox.co.passportfintech.com/v1/recipients/:recipient_id/resolve |
| Method | POST |
| Headers | Authorization |
| Authentication | Access Token (Bearer Token) |
Replace recipient_id with the actual unique ID of the recipient.
Request Body
- No request body
Example Request
2
curl --location --request POST 'https://api.paas.sandbox.co.passportfintech.com/v1/recipients/8e5dbe27-b17e-4366-a116-82f9c52bcdab/resolve' \--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \Response Body
- HTTP Status Code: 200 OK
- The response contains the recipient metadata.
Example of Response
29
29
{ "resolved_at": "2025-10-06T22:43:46.959Z", "expires_at": "2025-10-06T23:13:46.959Z", "id": "119f6b1c-9e0d-4457-863c-b4e605639dbe", "owner": { "business_name": "Merchant G60PG", "identification_type": "NIT", "identification_number": "642349532", "first_name": "", "type": "BUSINESS", "second_name": "", "first_last_name": "", "second_last_name": "" }, "participant": { "name": "", "identification_number": "123456789" }, "customer_id": "133009ae-cf5d-4140-a4e2-3f950aa5550f", "key": { "key_value": "3975999158", "key_type": "M" }, "account": { "account_number": "88758829529", "account_type": "ORDINARY" }, "receptor_node": "VIS"}The response confirms the recipient details and its association with a specific Bre-B Key within the central directory of the Banco de la República.
Common Errors and Handling
| HTTP Status Code | Meaning | Description |
|---|---|---|
| 400 Bad Request | Invalid Request | The recipient ID is missing or incorrectly formatted. |
| 401 Unauthorized | Expired Token | The access token is invalid or has expired. |
| 403 Forbidden | Access Denied | The request is not authorized to retrieve this recipient. |
| 404 Not Found | Recipient Not Found | No recipient was found with the given ID. |
| 500 Internal Server Error | Server Error | An unexpected error occurred while retrieving the recipient. |
Best Practices
- Ensure the recipient
idis correctly provided in the request URL. - Use the retrieved recipient details for initiating Bre-B payments - pass the
resolution_idwthin the Payment body.