# Loans

Este método se conecta a la cuenta especificada por el usuario en  y retorna todos los créditos contratados que puedan encontrarse dentro del sitio web.

El uso del campo  desencadenará un proceso asíncrono y los datos resultantes se enviarán más tarde al webhook especificado. Esta es la forma preferida de interactuar con nuestros servicios, ya que asegura que se harán todos los esfuerzos para extraer los datos y cumplir  con su solicitud dentro de un plazo razonable. Si desea la respuesta de inmediato, omita el campo  pero tenga en cuenta que puede provocar tiempos de espera dependiendo del tamaño del resultado de los datos y las condiciones de la red.

Endpoint: POST /v1/cl/banking/personal/bancosecurity.cl/products/loans
Version: v1.0
Security: JWT, Api-Key

## Request fields (application/json):

  - `RequestData` (object, required)
    Información necesaria para conectarse a la cuenta del usuario en el sitio web y extraer datos. Los campos obligatorios indican los valores necesarios para identificar la cuenta deseada.

  - `RequestData.AccountCredential` (any)
    Atención: El uso de este campo es obligatorio cuando se utiliza autenticación por Api Key.

  - `CallbackUrl` (string)
    URL para enviar el mensaje de respuesta utilizando un método POST.
    Example: "https://my-api.my-business.com/api/open-data-response"

## Response 200 fields (application/json):

  - `OperationId` (string, required)
    Identificador único de la operación.
    Example: "6baf6c19-e485-463b-ae24-a821b025c8a4"

  - `Status` (string, required)
    Estado de la operación.  significa que el servicio se ha ejecutado correctamente aunque no devuelva datos.  indica que ha ocurrido algo que ha impedido la finalización con éxito del proceso.
    Enum: "OK", "ERROR"

  - `Data` (object,null, required)
    Contenedor de créditos.

  - `Data.Loan` (array, required)
    Proporciona más detalles sobre los créditos. Puede ser un arreglo vacío.

  - `Data.Loan.Balance` (object, required)
    Objeto con información sobre el saldo de la deuda (también conocido como 'Monto pendiente').

  - `Data.Loan.Balance.Amount` (number, required)
    Número de unidades monetarias especificadas en una moneda activa en la que la unidad monetaria es explícita y conforme con la norma ISO 4217.
    Example: 10990

  - `Data.Loan.Balance.Currency` (string, required)
    Código asignado a una moneda por una Agencia de Mantenimiento con arreglo a un sistema de identificación internacional, tal como se describe en la última edición de la norma internacional ISO 4217 'Códigos para la representación de monedas y fondos'.
    Example: "CLP"

  - `Data.Loan.DueDate` (string, required)
    Fecha en la que el crédito está totalmente pagado.
    Example: "2023-07-26"

  - `Data.Loan.GrantDate` (string, required)
    Fecha en la que el crédito fue otorgado.
    Example: "2024-05-06"

  - `Data.Loan.GrantedAmount` (object, required)
    Objeto con información sobre el total de la deuda (también conocido como 'Monto otorgado').

  - `Data.Loan.InstalmentDetail` (object, required)
    Objeto con información sobre las cuotas del crédito.

  - `Data.Loan.InstalmentDetail.CurrentInstalmentNumber` (integer, required)
    Representación numérica de la cuota actual del crédito.
    Example: 7

  - `Data.Loan.InstalmentDetail.InstalmentsNumber` (integer, required)
    Representación numérica de la cantidad total de cuotas del crédito.
    Example: 9

  - `Data.Loan.LoanNumber` (string, required)
    Identificador único e inmutable utilizado para identificar el producto de crédito.
    Example: "75599"

  - `AdditionalInformation` (string,null, required)
    Este campo puede utilizarse para mostrar información relevante específica de la respuesta, por ejemplo indicando que el campo  está incompleto.

  - `Error` (object,null, required)
    Objeto con los detalles del error, utilizado cuando . Si  este campo será nulo. Puede leer una explicación completa de este objeto visitando [este enlace](https://docs.khipu.com/portal/en/errors/)

  - `Error.Code` (string)
    Código interno del sistema que identifica el error.
    Example: "E201"

  - `Error.Type` (string)
    Indica cómo tratar este código de error específico, en función del tipo de error.
    Enum: "RETRY_IMMEDIATELY", "DO_NOT_RETRY", "WAIT_4_HOURS_BEFORE_RETRY", "RETRY_AFTER_NOTIFICATION"

  - `Error.Description` (string)
    Descripción asociada al código de error.
    Example: "El servicio destino utilizado para la extracción de datos no se encuentra disponible."

  - `LifeSpan` (string,null, required)
    en peticiones sincrónicas.

## Response 202 fields (application/json):

  - `OperationId` (string, required)
    Identificador único de la operación.
    Example: "6baf6c19-e485-463b-ae24-a821b025c8a4"

  - `Status` (string, required)
    Estado de la operación. Al realizar solicitudes asíncronas, siempre devolverá .
    Example: "OK"

  - `Data` (object, required)
    en solicitudes asíncronas.

  - `AdditionalInformation` (string, required)
    Mensaje de la operación, puede usarse para mostrar información adicional.
    Example: "Data will be sent to the callback URL."

  - `Error` (object, required)
    en solicitudes asíncronas.

  - `LifeSpan` (string, required)
    Fecha máxima estimada de entrega para solicitudes asíncronas, en formato de fecha y hora ISO 8601, zona horaria UTC.
    Example: "2017-07-22T00:00:00-0400"