Crédito

Crédito #

Section renders pages in section as definition list, using title and description.

Example #

{{< section >}}
Crear crédito
Crear crédito # Permite crear un crédito y asociarlo a un lead o usuario. URL del endpoint # POST /create-loan Parámetros de entrada # Los parámetros deben enviarse en el cuerpo de la solicitud HTTP en formato JSON. A continuación, se detallan los parámetros requeridos: Parámetro Tipo Descripción user_id string Identificador único (UUID) del usuario asociado al préstamo. financial_entity_id string Identificador único (UUID) de la entidad financiera en la que se creará el préstamo.
Desembolsar crédito
Desembolsar crédito # Este método realiza el desembolso de un crédito existente. Verifica que el crédito no haya sido desembolsado previamente, valida los campos obligatorios y realiza los cálculos necesarios para re-amortizar el crédito en caso de ser necesario. También realiza transacciones de saldo entre la entidad financiera y el usuario, actualiza el estado del crédito a desembolsado y descarga el saldo al usuario. URL del endpoint # POST /loan-disbursement
Buscar crédito por ID
Buscar crédito por ID # Este método permite buscar un crédito por su ID. Este método retorna un objeto con la información relacionada a una línea de crédito existente usando su identificador único (UUID) asignado como parámetro de consulta. URL del endpoint # GET /loan Parámetros de entrada # Parámetro Tipo Descripción id string El identificador único del préstamo a consultar Encabezados # Encabezado Valor Authorization Bearer {token} Content-Type application/json Respuesta esperada # El método devuelve una respuesta en formato JSON con los siguientes campos:
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:
Actualizar producto de crédito
Actualizar producto de crédito # Este método permite actualizar un producto de crédito perteneciente a una Fintech del ecosistema de LeanCore. URL del endpoint # POST /update-loan-product Parámetros de entrada # Los parámetros deben enviarse en el cuerpo de la solicitud HTTP en formato JSON. A continuación, se detallan los parámetros requeridos: Parámetro Tipo Descripción uid str ID de la entidad financiera loan_product_name str Nombre del producto de crédito a actualizar name str Nombre del producto de crédito description str Descripción del producto de crédito loan_type str Tipo de préstamo (Ejemplo: Hipotecario, Automotriz) interest_rate float Tasa de interés del producto de crédito interest_rate_basis str Base de cálculo de la tasa de interés grace_period int Período de gracia (en meses) grace_period_interest_payment bool Especifica si durante el período de gracia se pagan intereses interest_free_period int Período sin intereses (en meses) other_expenses list Lista de otros gastos del producto de crédito payment_frequency str Frecuencia de pago del producto de crédito billing_interval_type str Tipo de intervalo de facturación (Ejemplo: Diario, Mensual) arrear_interest_rate float Tasa de interés de mora del producto de crédito arrear_interest_rate_basis str Base de cálculo de la tasa de interés de mora arrear_max_interest_rate float Tasa máxima de interés de mora del producto de crédito tax_rate float Tasa de impuestos aplicable al producto de crédito initial_charges list Lista de cargos iniciales del producto de crédito La lista de other_expenses contiene objetos JSON con los siguientes campos:
Eliminar producto de crédito
Eliminar producto de crédito # Este método permite borrar un producto de crédito perteneciente a una Fintech. URL del endpoint # POST /remove-loan-product Cabeceras de la petición # La petición debe incluir la cabecera Authorization con un token de tipo Bearer. 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 loan_product_name string Nombre del producto de crédito a borrar Respuesta esperada # 200 OK: El servidor ha recibido y procesado la petición correctamente.
Obtener créditos de un usuario de una Fintech
Obtener créditos de un usuario de una Fintech # Este método permite obtener los créditos de un usuario perteneciente a una Fintech según su número de identificación. URL del endpoint # POST /fintech-user-loans Parámetros de entrada # Los parámetros deben enviarse en el cuerpo de la solicitud HTTP en formato JSON. A continuación, se detallan los parámetros requeridos: Parámetro Tipo Descripción financialEntityId str ID de la entidad financiera userNID str Número de identificación del usuario Encabezados # Encabezado Valor Authorization Bearer {token} Content-Type application/json Respuesta esperada # La respuesta contendrá los créditos del usuario de la Fintech.
Obtener extracto de créditos de un usuario
Obtener extracto de créditos de un usuario # Este método permite obtener el extracto de los créditos registrados para un usuario. URL del endpoint # GET /user-loan-statement?nid=<user_nid> Parámetros de entrada # Parámetro Tipo Descripción nid string Número de identificación del usuario Encabezados # Encabezado Valor Authorization Bearer {token} Content-Type application/json Respuesta esperada # El método devuelve una respuesta en formato JSON con los siguientes campos:
Obtener estado de cuenta de créditos de un usuario
Obtener estado de cuenta de créditos de un usuario # Este método permite obtener el estado de cuenta de los créditos registrados para un usuario. URL del endpoint # GET /user-account-statement?nid=<user_nid> Parámetros de entrada # Parámetro Tipo Descripción nid string Número de identificación del usuario Encabezados # Encabezado Valor Authorization Bearer {token} Content-Type application/json Respuesta esperada # El método devuelve una respuesta en formato JSON con los siguientes campos:
Pagar crédito
Pagar crédito # Este método permite procesar una transacción de pago realizada por un usuario o comercio, definiendo la información del pagador y los detalles necesarios para la trazabilidad del pago. URL del endpoint # POST /pay-loan Parámetros de entrada # Los parámetros deben enviarse en el cuerpo de la solicitud HTTP en formato JSON. A continuación, se detallan los parámetros requeridos: Parámetro Tipo Descripción id string Identificador único (UUID) del del préstamo a pagar.
Pagar crédito a través de formulario
Pagar crédito a través de formulario # Este método permite pagar un crédito a través de un formulario enviado en el cuerpo de la petición como form-data. URL del endpoint # POST /pay-loan-form Parámetros de entrada # Los parámetros deben enviarse en el cuerpo de la solicitud HTTP como form-data. A continuación, se detallan los parámetros requeridos: Parámetro Tipo Descripción id string Identificador único (UUID) del del préstamo a pagar.
Obtener la deuda total de un crédito
Obtener la deuda total de un crédito # Este método permite obtener el valor total de la deuda de un crédito. URL del endpoint # GET /get-loan-total-debt Parámetros de entrada # Parámetro Tipo Descripción loan_id string ID del crédito payment_date string (Opcional) Fecha de la transacción de pago en formato ISO8601 Encabezados # Encabezado Valor Authorization Bearer {token} Content-Type application/json Respuesta esperada # El método devuelve una respuesta en formato JSON con los siguientes campos: