Skip to content
Loans
/
/
Index loans

Loans (1.0)

Download OpenAPI description
loans.json
loans.yaml
Languages
Servers
Mock Server

https://docs.solarisgroup.com/_mock/api-reference/lending/loans/

Loan servicing

Operations

Retrieve a loan schedule

Request

Returns the schedule of the loan specified in the request URL. The loan schedule includes the full details of a loan, such as loan balance, fees, penalities, interests, and all past, present, and future installments of the loan.

Path
loan_idstringrequired

The ID of the loan for which the schedule should be retrieved.

No request payload

Responses

Repayment Schedule

Bodyapplication/json
loan_balancesobject

An overview of the entire loan details, including principal, interests, penalities, and fees as of the current date.

installmentsArray of objects

An array of objects containing information about all the loan installments (past, present, and future).

Response
application/json
{
  "loan_balances": {
    "total": { … },
    "principal": { … },
    "penalty": { … },
    "interest_from_arrears": { … },
    "interest": { … },
    "fees": { … }
  },
  "installments": [
    { … }
  ]
}

Retrieve the history of repayments of a loan

Request

Returns the history of all past repayments the customer made in relation to the loan specified in the request URL. This includes all executed SEPA Direct Debits (SDD) and/or SEPA Credit Transfers (SCT).

Path
loan_idstringrequired

The ID of the loan for which the repayment history should be retrieved.

No request payload

Responses

Repayment history

Bodyapplication/json
repayment_historyArray of objects
Response
application/json
{
  "repayment_history": [
    { … }
  ]
}

Retrieve a loan

Request

Returns the details of the loan specified in the request URL.

Path
loan_idstringrequired

The ID of the loan to be retrieved.

No request payload

Responses

Loan

Bodyapplication/json
idstringrequired

The ID of the loan.

Example: "c13447d659db4cdcb450b977f8f25c57cloa"
statusstringrequired

The loan's status.

Enum"payout_initiation_pending""payout_initiation_blocked""payout_pending""payout_issued""all_obligations_met"
Example: "payout_issued"
person_idstringrequired

The person ID of the customer getting the loan.

Example: "547a870b2c8461a3104559369d09265dcper"
billing_account_idstring or nullrequired

The ID of the customer's billing account from which all the loan payments will be debited.

Example: "1d0e52af0a62b4b44d8c54a87a7fc6a7cacc"
amountSolarisToolkit.Web.Money (object)required

The loan amount.

SolarisToolkit.Web.Money (object)

The loan amount.

termnumberrequired

The number of months over which the loan will be repaid.

Example: 24
interest_ratenumberrequired

The monthly interest rate applied to a loan.

Example: 0.0499
recipient_ibanstringrequired

The IBAN to which the loan is paid out.

Example: "DE88888881010987654321"
repayment_begin_datestringrequired

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

Example: "2020-05-16"
payout_datestring(date)required

The date when the loan will be paid out.

Example: "2020-05-16"
interest_start_datestring(date)required

The date when the interest starts accruing on a loan.

Example: "2021-06-16"
effective_interest_ratenumberrequired

The annual effective interest rate applied to the loan.

Example: 0.0511
overdue_amountSolarisToolkit.Web.Money (object)required

An object representing the loan overdue amount.

SolarisToolkit.Web.Money (object)

An object representing the loan overdue amount.

created_atstring(datetime)required

The date when the loan was created.

Example: "2021-06-16T10:22:38"
total_loan_expenses(SolarisToolkit.Web.Money (object or null))

An object representing the loan total expenses (e.g., costs and expenses the lender incurred during a loan lifecycle).

(SolarisToolkit.Web.Money (object or null))

An object representing the loan total expenses (e.g., costs and expenses the lender incurred during a loan lifecycle).

status_reasonstring or null

Additional context around the loan status.

Enum"upfront_subsidy_pull_failed_collateral_account_not_set""upfront_subsidy_pull_failed_debit_blocked""upfront_subsidy_pull_failed_insufficient_funds"
repayment_plan_updated_atstring or null(datetime)

The date when the loan's repayment plan was last updated.

Example: "2021-04-16T13:52:05Z"
repayment_plan_created_atstring or null(datetime)

The date when the loan's repayment plan was created.

Example: "2020-04-16T13:52:05Z"
referencestring or null

A reference for the loan.

purposestring or null

The purpose of the loan.

Example: "Buying a car."
monthly_payment(SolarisToolkit.Web.Money (object or null))

An object representing the loan monthly installment amount.

(SolarisToolkit.Web.Money (object or null))

An object representing the loan monthly installment amount.

maturity_datestring or null

The date when the final loan payment is due.

Example: "2022-05-16"
loan_account_idstring or null

The account ID to which the loan is attached.

Example: "adc123a45d6d7cf8fbfeed537ba919d5cacc"
loan_account_ibanstring or null

The IBAN of the account to which the loan is attached.

Example: "DE72110101014351836685"
billing_account_ibanstring or null

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

Example: "DE72110101014351836685"
annual_percentage_ratenumber

A percentage that represents the yearly cost of funds over the term of a loan. It includes interest, fees and additional costs associated with a loan.

Response
application/json
{
  "total_loan_expenses": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "term": 24,
  "status_reason": "upfront_subsidy_pull_failed_collateral_account_not_set",
  "status": "payout_issued",
  "repayment_plan_updated_at": "2021-04-16T13:52:05Z",
  "repayment_plan_created_at": "2020-04-16T13:52:05Z",
  "repayment_begin_date": "2020-05-16",
  "reference": "string",
  "recipient_iban": "DE88888881010987654321",
  "purpose": "Buying a car.",
  "person_id": "547a870b2c8461a3104559369d09265dcper",
  "payout_date": "2020-05-16",
  "overdue_amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "monthly_payment": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "maturity_date": "2022-05-16",
  "loan_account_id": "adc123a45d6d7cf8fbfeed537ba919d5cacc",
  "loan_account_iban": "DE72110101014351836685",
  "interest_start_date": "2021-06-16",
  "interest_rate": 0.0499,
  "id": "c13447d659db4cdcb450b977f8f25c57cloa",
  "effective_interest_rate": 0.0511,
  "created_at": "2021-06-16T10:22:38",
  "billing_account_id": "1d0e52af0a62b4b44d8c54a87a7fc6a7cacc",
  "billing_account_iban": "DE72110101014351836685",
  "annual_percentage_rate": 0,
  "amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  }
}

Index loans

Request

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

Query
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.

No request payload

Responses

LoanEngine.ListLoansResponse

Headers
totalinteger
Bodyapplication/jsonArray [
idstringrequired

The ID of the loan.

Example: "c13447d659db4cdcb450b977f8f25c57cloa"
amountSolarisToolkit.Web.Money (object)required

The loan amount.

SolarisToolkit.Web.Money (object)

The loan amount.

repayment_begin_datestring or null

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

Example: "2020-05-16"
payout_datestring or null

The date when the loan will be paid out.

Example: "2020-05-16"
maturity_datestring or null

The date when the final loan payment is due.

Example: "2022-05-16"
loan_account_idstring or null

The account ID to which the loan is attached.

Example: "adc123a45d6d7cf8fbfeed537ba919d5cacc"
billing_account_ibanstring or null

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

Example: "DE72110101014351836685"
]
Response
application/json
[
  {
    "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": { … }
  }
]

Retrieve a credit line mandate

Request

Returns a signed mandate for a credit line.

Path
credit_line_idstringrequired

The ID of the credit line associated with the signed mandate.

No request payload

Responses

Mandate

Bodyapplication/json
signature_datestring

The date when the customer signed the SDD mandate for the loan repayment.

Example: "2020-08-24"
namestring

The name of the account holder.

Example: "Max Mustermann"
mandate_idstring

The ID of the signed mandate.

Example: "LOY327JAFM3V3M"
ibanstring

The IBAN of the account from which the loan repayments will be debited.

Example: "DE92370601930002130041"
bic_codestring

The bank identifier code of the customer's account.

Example: "SOBKDEBBXXX"
Response
application/json
{
  "signature_date": "2020-08-24",
  "name": "Max Mustermann",
  "mandate_id": "LOY327JAFM3V3M",
  "iban": "DE92370601930002130041",
  "bic_code": "SOBKDEBBXXX"
}

(DEPRECATED) Retrieve the repayment plan of a loanDeprecated

Request

Returns the repayment plan of the loan specified in the request URL. This endpoint is deprecated. Please use the repayment schedule endpoint instead.

Path
loan_idstringrequired

The ID of the loan for which the repayments to be returned.

No request payload

Responses

Repayments

Bodyapplication/json
updated_atstring or null(datetime)

The date when the loan repayment plan was last updated.

Example: "2021-04-16T13:52:05Z"
repaymentsArray of objects
created_atstring or null(datetime)

The date when the loan repayment plan was created.

Example: "2020-04-16T13:52:05Z"
Response
application/json
{
  "updated_at": "2021-04-16T13:52:05Z",
  "repayments": [
    { … }
  ],
  "created_at": "2020-04-16T13:52:05Z"
}

Loan dunning cases

Operations

Consumer Loan

Operations