Consultar saldo
Consulta el saldo a favor disponible de un cliente por moneda.
Descripción general
Este endpoint devuelve el saldo a favor disponible de un cliente. El saldo se lleva por moneda (MXN y USD): el saldo de cada moneda es la suma de los montos de sus movimientos.
currency_balances solo incluye las monedas con saldo mayor a cero; un cliente sin saldo a favor responde con el arreglo vacío. total_mxn_approx suma el saldo en MXN más el saldo en USD convertido con el tipo de cambio USD→MXN más reciente que tiene la plataforma. Si no hay un tipo de cambio registrado, el saldo en USD no se suma al total.
Requiere el permiso Leer en Pagos.
Endpoint
https://app.credonix.mx/api/v1/customers/{customerId}/creditPath param: customerId — ID del cliente.
Consulta el saldo de un cliente
Devuelve una entrada por cada moneda con saldo disponible y el total aproximado en MXN.
Cliente sin saldo a favor
Un cliente sin saldo a favor no es un error: responde 200 con currency_balances vacío y total_mxn_approx en "0.00".
Campos de la respuesta
| Campo | Tipo | Descripcion |
|---|---|---|
currency_balances | array | Saldo disponible por moneda. Solo incluye monedas con saldo mayor a cero. |
currency_balances[].currency | string | MXN o USD. |
currency_balances[].amount | string | Saldo disponible en esa moneda, con 2 decimales. |
total_mxn_approx | string | Saldo en MXN más el saldo en USD convertido con el tipo de cambio USD→MXN más reciente. Si no hay tipo de cambio registrado, no incluye el saldo en USD. |
Errores
| Status | Código | Causa |
|---|---|---|
401 | — | API key ausente, inválida o revocada. |
403 | INSUFFICIENT_PERMISSIONS | La API key no tiene el permiso Leer en Pagos. |
404 | CUSTOMER_NOT_FOUND | El cliente no existe o no pertenece a la organización. |