Retrieve 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/breb/:recipient_id |
| Method | GET |
| 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
3
curl --location 'https://api.paas.sandbox.co.passportfintech.com/v1/recipients/breb/daa209f9-fbdf-4f2b-aadc-db42fe16358c' \--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \--data ''Response Body
- HTTP Status Code: 200 OK
- The response contains the recipient metadata.
Example of Response
12
12
{ "customer_id": "3daa209f9-fbdf-4f2b-aadc-db42fe16358c", "key": { "key_type": "PHONE", "key_value": "3975999158" }, "type": "BREB", "updated_at": "2025-10-10T07:43:41.267Z", "created_at": "2025-10-10T07:43:41.267Z", "alias": "Pepito SAS5", "id": "daa209f9-fbdf-4f2b-aadc-db42fe16358c"}The response confirms the recipient details and its association with a specific entity customer.
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.