Agregar producto de crédito

Agregar producto de crédito #

Este método permite agregar una nueva línea de crédito a una entidad financiera existente en el ecosistema de LeanCore. La información requerida para agregar una línea de crédito se envía en los campos requeridos en el cuerpo de la solicitud.

URL del endpoint #

POST /add-loan-product

Parámetros de entrada #

La solicitud debe contener un objeto JSON en el cuerpo con los siguientes campos:

Nombre Tipo Descripción
uid string Identificador único de la entidad financiera
name string Nombre del producto de préstamo
description string Descripción del producto de préstamo
loan_type string Tipo de préstamo
interest_rate float Tasa de interés del préstamo
interest_rate_basis string Base sobre la que se calcula la tasa de interés
grace_period int Período de gracia en días
grace_period_interest_payment bool Indica si los intereses se pagan durante el periodo de gracia
interest_free_period int Período de libre interés en días
other_expenses list Lista de gastos adicionales del préstamo
payment_frequency string Frecuencia de pago del préstamo
billing_interval_type string Tipo de intervalo de facturación
arrear_interest_rate float Tasa de interés moratorio
arrear_interest_rate_basis string Base sobre la que se calcula la tasa de interés moratorio
arrear_max_interest_rate float Tasa máxima de interés moratorio
tax_rate float Tasa de impuestos
initial_charges list Lista de cargos iniciales

La lista de other_expenses contiene objetos JSON con los siguientes campos:

Parámetro Tipo Descripción
description str Descripción del gasto
amount float Monto del gasto
permanent bool Especifica si el gasto es permanente o no
terms int Número de periodos
in_percentage bool Especifica si el gasto es en porcentaje
outstanding_balance_calculation bool Especifica si el gasto se cobra con base en el saldo insoluto
additional_interest_rate bool Especifica si el gasto se agrega al cálculo de la cuota del crédito como un interés adicional

Cabeceras de la petición #

La petición debe incluir la cabecera Authorization con un token de tipo Bearer.

Respuesta esperada #

  • 200 OK: El servidor ha recibido y procesado la petición correctamente. Devolverá la información de la entidad financiera solicitada en formato JSON.

Ejemplo de respuesta #

{
  "id": "e55c7c2e-3d1a-4b7e-ae4f-1a2f52840d35",
  "name": "Mi entidad financiera",
  "description": "Descripción de mi entidad financiera",
  "nit": "900123456",
  "logo": "https://example.com/my_logo.png",
  "status": "active",
  "loan_products": [
    {
      "name": "Crédito libre destino",
      "description": "Descripción crédito",
      "loan_type": "free_investment",
      "interest_rate": 1.5,
      "interest_rate_basis": "monthly",
      "grace_period": 0,
      "grace_period_interest_payment": true,
      "interest_free_period": 0,
      "other_expenses": [
        {
          "description": "Seguro de vida",
          "amount": 1.0,
          "permanent": true,
          "in_percentage": true,
          "additional_interest_rate": true
        }
      ],
      "payment_frequency": "monthly",
      "billing_interval_type": "whole_month",
      "arrear_interest_rate": 0.1,
      "arrear_interest_rate_basis": "monthly",
      "arrear_max_interest_rate": null,
      "tax_rate": 19.0,
      "initial_charges": [
        {
          "name": "Cobro de onboarding",
          "amount": 100000
        }
      ]
    }
  ]
}

Ejemplo de uso #

import requests
import json

url = "https://api.leancore.co/add-loan-product"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

payload = {
    "uid": "<financial_entity_uid>",
    "name": "Sample loan product",
    "description": "This is a sample loan product",
    "loan_type": "personal",
    "interest_rate": 12.0,
    "interest_rate_basis": "annually",
    "grace_period": 0,
    "grace_period_interest_payment": True,
    "interest_free_period": 0,
    "other_expenses": [
        {
            "description": "processing fee",
            "amount": 100.0,
            "permanent": True,
            "in_percentage": False
        },
        {
            "description": "late payment fee",
            "amount": 50.0,
            "permanent": False,
            "in_percentage": True
        }
    ],
    "payment_frequency": "monthly",
    "billing_interval_type": "arrears",
    "arrear_interest_rate": 0.0,
    "arrear_interest_rate_basis": "annually",
    "arrear_max_interest_rate": 0.0,
    "tax_rate": 0.0,
    "initial_charges": [
        {
            "name": "registration fee",
            "amount": 500.0
        },
        {
            "name": "documentation fee",
            "amount": 250.0
        }
    ]
}

response = requests.post(url, headers=headers, data=json.dumps(payload))
print(response.json())