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://bre-b-sandbox.api.visionamos.passportfintech.com/v1/paas/entities/customers/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://bre-b-sandbox.api.visionamos.passportfintech.com/v1/paas/entities/customers/breb/recipients/8e5dbe27-b17e-4366-a116-82f9c52bcdab' \--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \--data ''Response Body
- HTTP Status Code: 200 OK
- The response contains the recipient metadata.
Example of Response
6
6
{ "key_value": "jimmyjohns8@test.com", "entity_customer_id": "d490794d-183f-4226-80a7-e75edce0e4fe", "key_type": "E", "id": "8e5dbe27-b17e-4366-a116-82f9c52bcdab"}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.