Loan

Loan #

Crear préstamo #

Asigna un producto de crédito a un cliente dentro del ecosistema de préstamo. Use este método para procesar una transacción de colocación de crédito entre su entidad y el ecosistema de consumo del cliente, defina los detalles en cada parámetro que darán trazabilidad a la asignación del producto de crédito.

La asignación de préstamo en la cuenta de un cliente se verá reflejada en aquellos que fueron convertidos de lead a cliente de forma previa. Consulte la guía relacionada Convertir lead en cliente.

Ejemplo

POST /create-loan

{
  "user_id": "string",
  "financial_entity_id": "string",
  "amount": 0,
  "loan_type": "ipc_indexed" | "free-investment",
  "interest_rate": 0,
  "interest_rate_basis": "string",
  "other_expenses": [
    {
      "description": "string",
      "amount": 0,
      "permanent": "boolean",
      "terms": null,
      "in_percentage": "boolean"
    }
  ],
  "term": 0,
  "payment_frequency": "string",
  "assignment_date": "date",
  "cut_off_date": "date",
  "payment_date": "date",
  "additional_data": {
    "número de contrato de crédito": "string",
    "ipc inicial": "string",
    "spread": "string",
    "fecha de desembolso": "string",
    "universidad": "string",
    "programa academico": "string",
    "valor periodo académico": "string",
    "¿beneficiario del impulso financiero?": "string",
    "tipo de impulso financiero": "string",
    "¿tasa subvencionada?": "string",
    "tipo de subvención": "string"
  }
}

Resultado

{
    "id": "string",
    "user_id": "string",
    "financial_entity_id": "string",
    "loan_type": "string",
    "amount": 0,
    "interest_rate": 0,
    "interest_rate_basis": "string",
    "other_expenses": [
        {
            "description": "string",
            "amount": 0,
            "permanent": "boolean",
            "terms": null,
            "in_percentage": "boolean"
        }
    ],
    "term": 0,
    "payment_amount": 00,
    "payment_frequency": "monthly",
    "amortization": {
        "principal": [],
        "interest": [],
        "payment_info": [],
        "payment_amount": [
            {
                "total_amount": 0,
                "principal_payment_amount": 0,
                "interest_amount": 0,
                "other_expenses": [
                    {
                        "description": "string",
                        "amount": 0,
                        "permanent": "boolean",
                        "terms": null,
                        "in_percentage": "boolean"
                    }
                ]
            },
            ...
        ]
    },
    "principal_amount": 0,
    "interest_amount": 0,
    "period": 0,
    "assignment_date": "date",
    "cut_off_date": "date",
    "payment_date": "date",
    "grace_period": 0,
    "grace_period_without_interest": "boolean",
    "interest_free_period": 0,
    "disbursed": "boolean",
    "additional_data": {
        "número de contrato de crédito": "string",
        "ipc inicial": "string",
        "spread": "string",
        "fecha de desembolso": "string",
        "universidad": "string",
        "programa academico": "string",
        "valor periodo académico": "string",
        "¿beneficiario del impulso financiero?": "string",
        "tipo de impulso financiero": "string",
        "¿tasa subvencionada?": "string",
        "tipo de subvención": "string"
    },
    "billing_interval_type": "to_cutoff_date",
    "arrear_interest_rate": 0.0,
    "arrear_interest_rate_basis": "monthly",
    "arrear_max_interest_rate": "boolean"
}

Uso en la cabecera de petición Authorization

Authorization: Bearer <access>

Consultar préstamo #

Devuelve un objeto con la información relacionada a un producto de crédito específico. Realice esta solicitud enviando el id asignado al producto como valor requerido en la consulta.

Ejemplo

GET /loan

https://www.api.sandbox-middleware.leancore.co/loan?id=2ff45f9a-e8ea-4fa0-bb9b-83b46fc69645

Resultado

{
  "amortization": {
    "interest": [],
    "principal": []
  },
  "amount": 0,
  "assignment_date": "string",
  "cut_off_date": "string",
  "id": "string",
  "interest_amount": 0,
  "interest_rate": 0,
  "loan_type": "string",
  "other_expenses": [{}],
  "payment_amount": 0,
  "payment_date": "string",
  "payment_frequency": "string",
  "period": 0,
  "principal_amount": 0,
  "term": 0
}

Uso en la cabecera de petición Authorization

Authorization: Bearer <access>

Pagar préstamo #

Permite generar una transacción de pago de crédito por un usuario definiendo los parámetros que darán trazabilidad a la operación de pago.

Ejemplo

POST /pay-loan

{
    "id": "string",
    "amount": 0,
    "date": "date",
    "details": {
        "regular_payment": "boolean",
        "payment_type": "regular_payment" | "payment_advance" | "partial_payment" | "overdue_payment" | "full_payment" | "payment_amount_decrease" | "term_decrease",,
        "payment_support_description": "string",
        "payment_support": "url",
        "term": 0
    }
}

Resultado

{
  "amortization": {
    "interest": [],
    "principal": []
  },
  "amount": 0,
  "assignment_date": "string",
  "cut_off_date": "string",
  "id": "string",
  "interest_amount": 0,
  "interest_rate": 0,
  "loan_type": "string",
  "other_expenses": [{}],
  "payment_amount": 0,
  "payment_date": "string",
  "payment_frequency": "string",
  "period": 0,
  "principal_amount": 0,
  "term": 0,
  "details": {
    "regular_payment": "boolean",
    "payment_type": "regular_payment" | "payment_advance" | "partial_payment" | "overdue_payment" | "full_payment" | "payment_amount_decrease" | "term_decrease",
    "payment_support_description": "string",
    "payment_support": "string",
    "term": 0
  }
}

Uso en la cabecera de petición Authorization

Authorization: Bearer <access>

Desembolso de préstamo #

Permite desembolsar un préstamo previamente asignado para un usuario.

Ejemplo

POST /loan-disbursement

{
  "loan_id": "string",
  "amount": 0,
  "date": "string",
  "details": {
    "account": "string",
    "bank": "string",
    "payment_support": "string"
  }
}

Resultado

{
  "id": "string",
  "from_user": "string",
  "from_user_id": "string",
  "to_user": "string",
  "to_user_id": "string",
  "status": "approved",
  "amount": 0,
  "date": "date",
  "details": {
    "account": "string",
    "bank": "string",
    "payment_support": "string"
  },
  "reference": "string"
}

Uso en la cabecera de petición Authorization

Authorization: Bearer <access>