Prepago
Esta API permite la generación de pagos anticipados para contratos en curso, ofreciendo diversas configuraciones de acuerdo con el fondo y facilitando simulaciones antes de la efectivización del prepago. Además, es posible consultar la posición del crédito y también el(los) boleto(s) generado(s) después de la efectivización del prepago.
Posición del Crédito
Muestra información relacionada con el crédito de un contrato en un día específico, útil para verificar la situación del contrato antes y después de un posible anticipo.
// ejemplo de respuesta:
[
{
"amortization_type": "InstallmentFlow",
"balance_date": "2023-08-02T00:00:00.000Z",
"contract_number": "1247244/HYD",
"currency": "BRL",
"installments": [
{
"amount_at_maturity": 136.1,
"curve_value": 140.62,
"discount": 0,
"installment_number": 1,
"principal": 117.28,
"status_description": "Opened"
}
],
"is_vnp": true,
"position_date": "2023-08-02T00:00:00.000Z",
"trade_id": 11266246
}
]
Configuraciones del Fondo
Las configuraciones del fondo se refieren a las diferentes formas y reglas con las que ese fondo maneja la generación de pagos anticipados. Tales configuraciones son previamente establecidas por el equipo interno de gestión de contratos, pudiendo existir diferentes tipos, cada uno con criterios específicos. Ejemplos de configuraciones soportadas:
allow_partial_prepayment: valor booleano que informa si es posible anticipar solo algunas cuotas del contrato.
allowed_order:
- ASC: el anticipo de las cuotas debe seguir el orden ascendente.
- DESC: el anticipo de las cuotas debe seguir el orden descendente.
- ANY: el anticipo de las cuotas puede seguir cualquier orden, siempre que sean en secuencia.
wallet_closing_time: indica hasta qué hora podrá solicitarse el prepago en el día en específico.
allow_vnp_prepayment: valor booleano que informa si es posible realizar el pago de cuotas atrasadas/vencidas.
future_payment_date: valor booleano que informa si es posible realizar el pago en días futuros.
minimun_accrual_days: número mínimo de días necesarios para la emisión del prepago después de la vigencia del contrato.
maximum_prepayment_days_before_due: número de días anteriores al vencimiento de la cuota que no permiten el prepago.
prepayment_method:
- PREPAYMENT: permite solamente el pago del valor completo de las cuotas.
- AMORTIZATION: permite el pago parcial del valor de las cuotas.
settlement_method: lista los tipos de pagos permitidos (Boleto, TED, PIX, Débito en Cuenta).
// ejemplo de configuración:
{
"cge": "6666666",
"id": "00000000-0000-0000-0000-000000000000",
"name": "Nombre aquí",
"prepayment": {
"allow_partial_prepayment": false,
"allow_vnp_prepayment": false,
"allowed_order": "ANY",
"closing_time": "23:00:00",
"future_payment_date": true,
"maximum_prepayment_days_before_due": 0,
"minimum_accrual_days": 5,
"prepayment_method": "PREPAYMENT",
"settlement_methods": [
{
"id": 3,
"name": "Boleto",
"short_name": "BOLETO"
}
]
},
"tax_id": "444490909000444",
"texts": {
"AMORTIZATION_ALERT_EMAIL": "nombre@suProveedor.com",
"AMORTIZATION_ALERT_MESSAGE": "Cuerpo del mensaje aquí",
"AMORTIZATION_ALERT_TITLE": "Título del mensaje aquí"
}
}
Simulación
La simulación de un prepago es la etapa en la que se aplican las reglas de acuerdo con las configuraciones del fondo citadas anteriormente; es necesario informar el número del contrato contract_number, el identificador del fondo fund_tax_id, las cuotas a anticipar installments y, por último, la fecha de la posición position_date.
// ejemplo de respuesta:
{
"simulation_identification": "FDA4162DA3999EB0570307A7356110F5-638101491065224458",
"value_to_pay": 244.18
}
Confirmación
Después de una simulación exitosa se obtendrá el valor simulation_identification, que será necesario para confirmar la generación del prepago, donde la generación del anticipo se volverá de hecho efectiva.
// ejemplo de respuesta:
{
"barcode_number": 2.0890001091e+46
}
Boletos
Después de la confirmación de un prepago, es posible consultar el boleto generado para el pago; basta con informar el número de la simulación simulation_identification.
// ejemplo de respuesta:
string (base64)