¿Cómo manejar el amount y el balance en la integración por API?

Este artículo aplica solo si informas 2 interfases.

En cada orden de pago debes enviar su amount (monto original) y balance (saldo pendiente). A continuación, te explicaremos cómo enviar correctamente estos campos.

¿Qué significan estos campos?

Amount: Es el monto total original de la cuota o deuda. Es decir, es el valor pactado desde el comienzo con el cliente.

Ejemplo: Si la deuda original era de 100 USD + 2 USD de intereses pactados desde el comienzo, el amount es 102 USD.

Balance: Es el saldo pendiente a pagar de la orden de pago. Será el que modifiques cada vez que el cliente pague.

Ejemplo: Si el cliente debe 102 USD + 5 USD de mora, el balance es 107 USD.

  📌 Importante:

No alteres el amount original con intereses por mora o recargos. Mantener el valor original ayuda a conservar coherencia con los contratos y el plan de pagos.

Actualiza el balance cuando haya intereses por mora, pagos o descuentos. Si la deuda fue pagada y el saldo queda en 0, informa balance: 0 para que se detengan las comunicaciones automáticas por esa orden de pago.

Conserva todo el historial de las órdenes de pago con sus cuotas. Carga siempre el plan completo de cuotas desde el inicio. No elimines cuotas pagadas ni créditos cerrados, y si necesitas actualizar, asegúrate de modificar correctamente el balance.

Ejemplo de estructura correcta

Errores comunes que debes evitar

Cargar mora en el amount en lugar de en el balance.
Enviar balance menor a cero.
No enviar la actualización del balance a 0 en las cuotas pagadas.
Borrar órdenes sin justificación.

💡 Aprende más sobre la integración mediante API accediendo a los siguientes recursos:

🚀 Artículo: Integración mediante API.

🚀 Artículo: Cargar variables auxiliares al crear un batch por API.