Listar Destinatarios

Visión General

Este endpoint permite obtener un listado de todos los destinatarios Bre-B o ACH 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
Método	GET
Encabezados	Authorization
Autenticación	Token de Acceso (Bearer Token)

Este endpoint recupera todos los destinatarios vinculados a un cliente.

Parámetros de Consulta

Parámetros de paginación

Parámetro	Descripción
page_params.page_size	Cantidad de registros a retornar por página.
page_params.page_number	Número de página a consultar.
page_params.first_request_timestamp.seconds	Segundos UTC desde Unix epoch (`1970-01-01T00:00:00Z`). Debe estar entre `0001-01-01T00:00:00Z` y `9999-12-31T23:59:59Z` (inclusive).
page_params.first_request_timestamp.nanos	Fracción en nanosegundos (0 a 999,999,999). Debe ser un valor no negativo y representa la fracción de segundo con resolución de nanosegundos.

Parámetros de Ordenamiento

Parámetro	Descripción
order_params.order_key	Campo utilizado para ordenar los resultados.
order_params.order_direction	Dirección del ordenamiento. Valores permitidos: `ORDER_DIRECTION_ENUM_UNSPECIFIED`, `ASC`, `DESC`.

Filtros de Destinatarios

Parámetro	Descripción
customer_id	Filtra por el identificador del cliente asociado al destinatario.
type	Filtra por tipo de destinatario (por ejemplo, `INDIVIDUAL` o `BUSINESS`, según los valores soportados).
recipient_id	Filtra por el identificador único del destinatario.
identification_number	Filtra por el número de identificación del destinatario.
account_number	Filtra por el número de cuenta del destinatario.
account_type	Filtra por el tipo de cuenta del destinatario (por ejemplo, cuenta de ahorros u ordinaria, según los valores soportados).

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.
Guarda los IDs de los destinatarios para usarlos en pagos Bre-B u otras transacciones.

Última actualización el