Consultar Destinatario

Visión General

Este endpoint permite recuperar los detalles de un Destinatario Bre-B o ACH específico en la API de Passport usando el ID único del recipiente. La respuesta incluye el tipo de llave del destinatario, valor de la llave y detalles de la entidad asociada.

Detalles del Endpoint

Par��metro	Descripción
Endpoint	https://api.paas.sandbox.co.passportfintech.com/v1/recipients/:recipient_id
Método	GET
Encabezados	Content-Type: application/json, Authorization
Autenticación	Token de Acceso (Bearer Token)

Reemplaza recipient_id con el ID único real del destinatario.

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/8e5dbe27-b17e-4366-a116-82f9c52bcdab' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
Copy

Cuerpo de la Respuesta

Código HTTP: 200 OK
Retorna los datos del destinatario creado junto con su ID único.

Ejemplo de Respuesta

JSON
    
 
{
    "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

La respuesta confirma los detalles del destinatario y su asociación con el cliente específico.

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 acceder a este destinatario.
404 Not Found	No encontrado	No se encontró ningún destinatario con el ID proporcionado.
500 Server Error	Error del servidor	Ocurrió un error inesperado al recuperar los datos del destinatario.

Buenas Prácticas

Asegúrate de proporcionar correctamente el id del destinatario en la URL de la solicitud.
Utiliza los detalles del destinatario obtenidos para iniciar pagos Bre-B.

Última actualización el