latestOpenAPI 3.0.02026-08-102034118.0 KB

8f580eff2157

Loan servicing

Index loans

Returns an array containing all loans for all of your customers.

get/v1/loans

Query parameters

page[number]integer

Specifies the number of pages of results to return.

page[size]integer

Specifies the size of each page of results.

filter[credit_reference_id]string

Filters the returned loans by a specific credit_reference_id.

Response

LoanEngine.ListLoansResponse

repayment_begin_datestring nullable

The date when the loan's first monthly installment is due.

payout_datestring nullable

The date when the loan will be paid out.

maturity_datestring nullable

The date when the final loan payment is due.

loan_account_idstring nullable

The account ID to which the loan is attached.

idstring required

The ID of the loan.

billing_account_ibanstring nullable

The IBAN of the customer's billing account associated with the loan.

Example response

[
  {
    "repayment_begin_date": "2020-05-16",
    "payout_date": "2020-05-16",
    "maturity_date": "2022-05-16",
    "loan_account_id": "adc123a45d6d7cf8fbfeed537ba919d5cacc",
    "id": "c13447d659db4cdcb450b977f8f25c57cloa",
    "billing_account_iban": "DE72110101014351836685",
    "amount": {
      "value": 1000,
      "unit": "cents",
      "currency": "EUR"
    }
  }
]