Listar Destinatarios

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://api.paas-sandbox.co.passportfintech.com/v1/recipients/breb
Método	GET
Encabezados	Authorization
Autenticación	Token de Acceso (Bearer Token)

Este endpoint recupera todos los destinatarios vinculados a un cliente.

Cuerpo de la Solicitud

No se requiere cuerpo en la solicitud para este endpoint.

Ejemplo de Solicitud

JSON
    
 
curl --location --request GET 'https://api.paas-sandbox.co.passportfintech.com/v1/recipients/breb' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
Copy

Cuerpo de la Respuesta

Código HTTP: 200 OK
Retorna los datos los destinatarios creados junto con sus IDs únicos.

Ejemplo de Respuesta

JSON
    
 
{
    "pagination_info": {
        "total_elements": 1,
        "first_request_timestamp": "2025-10-10T07:51:36.8Z",
        "current_page": 1,
        "total_pages": 1
    },
    "recipients": [
        {
            "customer_id": "31eb66c3-f309-48ce-8b12-086f9e76b84c",
            "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"
        }
    ]
}
Copy

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.

Última actualización el