# Loans

This method connects to the user's account in  and returns all Loans that can be found within the website (if the bank service is not showing the data for any product due to website issues, the respective  product will be omitted from the response).

Using the  field will trigger an asynchronous process and the resulting data will be sent later to the specified webhook. This is the preferred way to interact with our services, as it assures that all efforts will be made to extract the data to fulfill  your request within a reasonable time frame. If you want the response immediately, skip the field  but bear in mind that it can result in timeouts depending on the data's result size and the network conditions.

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

## Request fields (application/json):

  - `RequestData` (object, required)
    Information needed to connect to the user's bank account and extract data. Mandatory fields indicates values that are necessary to identify the desired account.

  - `RequestData.AccountCredential` (any)
    Attention: The use of this field is mandatory when using Api Key authentication.

  - `CallbackUrl` (string)
    URL to send the response message using a POST verb.
    Example: "https://my-api.my-business.com/api/open-data-response"

## Response 200 fields (application/json):

  - `OperationId` (string, required)
    Unique identifier of the operation.
    Example: "6baf6c19-e485-463b-ae24-a821b025c8a4"

  - `Status` (string, required)
    Operation status.  means that the service was executed successfully even if it does not return Data.  indicates that something happened that prevented the successful completion of the process.
    Enum: "OK", "ERROR"

  - `Data` (object,null, required)
    Container for Loans.

  - `Data.Loan` (array)
    Array that contains the user's loan products.

  - `Data.Loan.LoanNumber` (string, required)
    A unique and immutable identifier used to identify the loan product (also known as "Número de Crédito").
    Example: "12341234"

  - `Data.Loan.ContractDate` (string, required)
    Contract date on the loan (also known as 'Fecha Contratacion')
    Example: "2023-03-01"

  - `Data.Loan.Balance` (object, required)
    Object with information on the balance of the debt (also known as 'Saldo de la deuda')

  - `Data.Loan.Balance.Amount` (number, required)
    A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
    Example: "123"

  - `Data.Loan.Balance.Currency` (string, required)
    A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
    Example: "CLP"

  - `Data.Loan.GrantedAmount` (object, required)
    Object with information on the total of the debt (also known as 'Monto del crédito')

  - `Data.Loan.InstalmentDetail` (object, required)
    Object with information about the instalments on the loan

  - `Data.Loan.InstalmentDetail.InstalmentsNumber` (string, required)
    Numerical representation of the total amount of instalments of the loan
    Example: "10"

  - `Data.Loan.InstalmentDetail.CurrentInstalmentNumber` (string, required)
    Numerical representation of the current instalment of the loan
    Example: "1"

  - `Data.Loan.InstalmentDetail.Amount` (object, required)
    Amount of money of the current Instalment

  - `Data.Loan.InstalmentDetail.NextDueDate` (string)
    Date of the next due date of the current instalment of the loan
    Example: "2023-08-31"

  - `AdditionalInformation` (string,null, required)
    This field can be used to display relevant information specific to the response, for instance indicating that the  field is incomplete.

  - `Error` (object,null, required)
    Object with the error details, used when . If  this field will be null. You can read a complete explanation of this object visiting [this link](https://docs.khipu.com/portal/en/errors/)

  - `Error.Code` (string)
    Internal system code that identifies the error.
    Example: "E201"

  - `Error.Type` (string)
    Indicates how to treat this specific error code, based on the type of error.
    Enum: "RETRY_IMMEDIATELY", "DO_NOT_RETRY", "WAIT_4_HOURS_BEFORE_RETRY", "RETRY_AFTER_NOTIFICATION"

  - `Error.Description` (string)
    Description associated with the error code.
    Example: "El servicio destino utilizado para la extracción de datos no se encuentra disponible."

  - `LifeSpan` (string,null, required)
    in sync requests.

## Response 202 fields (application/json):

  - `OperationId` (string, required)
    Unique identifier of the operation.
    Example: "6baf6c19-e485-463b-ae24-a821b025c8a4"

  - `Status` (string, required)
    Operation status. When making async requests it will always return .
    Example: "OK"

  - `Data` (object, required)
    in async requests.

  - `AdditionalInformation` (string, required)
    Operation message, can be used to display additional information.
    Example: "Data will be sent to the callback URL."

  - `Error` (object, required)
    in async requests.

  - `LifeSpan` (string, required)
    Max estimated delivery date for async requests, in ISO 8601 date format, UTC timezone.
    Example: "2017-07-22T00:00:00-0400"