Cuentas, saldo y extracto
La API de Cuentas, Saldo y Extracto LATAM le permite consultar las cuentas de su empresa, el saldo disponible de cada una y el extracto de movimientos de un período.
Esta API está disponible en el entorno de sandbox.
Casos de Uso
- Listar las cuentas de la empresa a las que su token puede acceder.
- Consultar el saldo disponible antes de iniciar un pago.
- Consultar el extracto de un período.
- Conciliar pagos y cobros.
Cuentas
La consulta lista las cuentas de la empresa a las que su token tiene acceso. Las cuentas son administradas por el banco y esta API no las crea, por lo que solo hay consulta. El accountId devuelto identifica la cuenta en las demás consultas.
Saldo
El saldo disponible es el total de créditos menos débitos y bloqueos. La plataforma calcula el valor y no se puede modificar. Un movimiento reciente puede tardar algunos segundos en reflejarse, y el campo calculatedAt informa el instante del cálculo.
Extracto
El extracto devuelve los movimientos del período en orden de fecha, con los saldos inicial y final. El saldo final es siempre el saldo inicial más la suma de los movimientos.
Cada asiento incluye:
- El valor, la fecha y si es un crédito o un débito.
- La contraparte del movimiento.
ref, que apunta al origen del asiento, como el pago que generó el débito.sourceEvent, el hecho que generó la línea, lo que permite conciliar sin depender del texto dedescription.
Un asiento no se modifica después de creado. Una corrección genera un nuevo asiento.
El extracto se puede obtener en application/json o en application/pdf, según el header Accept.
Recursos Disponibles
Los recursos de la API de Cuentas, Saldo y Extracto LATAM están disponibles en el API Reference.