/lending/v1/credit-lines/{credit_line_id}/debt/simulation

Simular deuda

El endpoint lending/v1/credit-lines/{credit_line_id}/debt/simulation te permite simular la aceleración de la deuda de una línea de crédito. La simulación no ejecuta la aceleración.

  • El tipo de simulación depende del país de la línea de crédito:
    • Brasil: si no enviás transaction_ids, se simula la aceleración total (type TOTAL_ACCELERATION). Si los enviás, se simula el anticipo de esos planes de cuotas (type INSTALLMENTS_ACCELERATION).
    • Chile: siempre se simula la cancelación con aceleración total de la deuda (type CANCELLATION_WITH_ACCELERATION) y se ignoran los transaction_ids.
    • Para el resto de los países, la operación no está disponible.
  • La línea de crédito debe estar en estado ACTIVE; si no, se rechaza con 400 BAD_REQUEST (en Chile, con 422 SIMULATE_DEBT_ACCELERATION_ERROR).
  • En Chile, si ya se confirmó una aceleración de la deuda en el día (en la zona horaria del país), se rechaza con 422 SIMULATE_DEBT_ACCELERATION_ERROR.
  • Si algún transaction_id no corresponde a la línea de crédito, o la simulación no se puede realizar, se rechaza con 422 SIMULATE_DEBT_ACCELERATION_ERROR (en Chile, CANCELLATION_WITH_ACCELERATION_ERROR).
  • La simulación de aceleración total y la de cancelación quedan guardadas como la simulación vigente de la línea de crédito; la de cuotas no se guarda.

Parámetros disponibles

Path Parameters
credit_line_idString
Query Parameters
transaction_idsString

Autenticación

🔒BearerAuthhttp

Detalle de respuestas

401
El token falta o es inválido. La respuesta no tiene cuerpo.
403
Sin cuerpo. El token es válido pero no tiene el scope que requiere el endpoint.

Ejemplo de código
curl -X GET "https://api.pomelo.la/lending/v1/credit-lines/example_value/debt/simulation?transaction_ids=ctx-2utzQVe7X7RfXrVUOPIJgCzRtx1,ctx-2utzQZBjBp3v2nzg1XsKgYGo9JL,lrp-2HMvSzWjc5La6WDTlgFweXAmPle" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"
Ejemplo de respuesta (200)OK
{
  "data": {
    "total": {
      "amount": "5000.00",
      "currency": "BRL",
      "discounted_interest": "120.50"
    },
    "current": {
      "amount": "1500.00",
      "currency": "BRL"
    },
    "acceleration": {
      "amount": "1500.00",
      "currency": "BRL"
    },
    "has_pending_operations": false,
    "type": "TOTAL_ACCELERATION",
    "status": "UNCONFIRMED"
  }
}

Pomelo AI

Asistente de inteligencia artificial para consultas sobre la API de Pomelo
¡Hola!¿Cómo puedo ayudarte hoy?