Consultar Cuenta
Visión General
Este endpoint permite consultar los detalles de una cuenta específica dentro de la API de Passport utilizando su identificador único. La respuesta incluye el tipo de cuenta, número, saldos disponibles y pendientes, así como la relación con el cliente entidad correspondiente.
Detalles del Endpoint
Parámetro | Descripción |
---|---|
Endpoint | https://bre-b-sandbox.api.visionamos.passportfintech.com/v1/paas/entities/customers/accounts/{account_id} |
Método | GET |
Encabezados | Authorization |
Autenticación | Token de Acceso (Bearer Token) |
Cuerpo de la Solicitud
- No se requiere cuerpo en la solicitud para este endpoint.
Ejemplo de Solicitud
3
curl --location 'https://bre-b-sandbox.api.visionamos.passportfintech.com/v1/paas/entities/customers/accounts/496b2d7f-571e-4363-8239-373b99e01483' \
--header 'Authorization: Bearer TU_TOKEN_DE_ACCESO' \
--data ''
Cuerpo de la Respuesta
- Código HTTP: 200 OK
- Retorna los datos de la cuenta asociada al cliente junto con su ID único.
Ejemplo de Respuesta
14
14
{
"entity_customer_id": "0e405bc0-fc6f-45fa-8778-f0433b291825",
"type": "LOW_VALUE",
"available_balance": {
"currency": "COP",
"value": "0"
},
"pending_balance": {
"currency": "COP",
"value": "0"
},
"id": "496b2d7f-571e-4363-8239-373b99e01483",
"number": "880794554"
}
El campo available_balance
representa los fondos disponibles para ser utilizados de forma inmediata, mientras que pending_balance
refleja las transacciones que aún están en proceso de liquidación.
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 | No tienes permisos para consultar esta cuenta. |
404 Not Found | Cuenta no encontrada | No se encontró ninguna cuenta con el ID proporcionado. |
500 Server Error | Error del servidor | Error inesperado al consultar los detalles de la cuenta. |
Buenas Prácticas
- Verifica que el
id
de la cuenta esté correctamente formateado y presente en la URL. - Usa los detalles de la cuenta obtenidos para gestionar transacciones o consultar saldos.