List All Recipients
Visión General
Este endpoint permite obtener un listado de todos los destinatarios Bre-B asociados a los clientes de la entidad dentro de la API de Passport. La respuesta incluye detalles como el tipo de llave del destinatario, el valor de la llave y el ID del cliente entidad relacionado.
Detalles del Endpoint
| Parámetro | Descripción |
|---|---|
| Endpoint | https://bre-b-sandbox.api.visionamos.passportfintech.com/v1/paas/entities/customers/recipients/breb |
| Método | GET |
| Encabezados | Authorization |
| Autenticación | Token de Acceso (Bearer Token) |
Este endpoint recupera todos los destinatarios vinculados a una entidad autenticada.
Cuerpo de la Solicitud
- No se requiere cuerpo en la solicitud para este endpoint.
Ejemplo de Solicitud
3
3
curl --location 'https://bre-b-sandbox.api.visionamos.passportfintech.com/v1/paas/entities/customers/breb/recipients' \--header 'Authorization: Bearer TU_TOKEN_DE_ACCESO' \--data '''Cuerpo de la Respuesta
- Código HTTP: 200 OK
- Retorna los datos los destinatarios creados junto con sus IDs únicos.
Ejemplo de Respuesta
10
10
{ "breb_recipients": [ { "id": "8e5dbe27-b17e-4366-a116-82f9c52bcdab", "entity_customer_id": "cde52c0b-029e-47a7-b6fe-58996680611f", "key_type": "E", "key_value": "jimmyjohns8@test.com" } ]}Errores Comunes y Manejo
| Código HTTP | Significado | Descripción |
|---|---|---|
| 400 Bad Request | Datos inválidos | Faltan campos requeridos o contienen valores incorrectos. |
| 401 Unauthorized | Token inválido | El token de acceso ha expirado o es inválido. |
| 403 Forbidden | Acceso denegado | La solicitud no está autorizada para listar destinatarios. |
| 500 Server Error | Error del servidor | Ocurrió un error inesperado al recuperar los destinatarios. |
Buenas Prácticas
- Asegúrate de que el token de autenticación sea válido antes de hacer la solicitud.
- Implementa Paginación si estás trabajando con grandes volúmenes de destinatarios.
- Guarda los IDs de los destinatarios para usarlos en pagos Bre-B u otras transacciones.