Skip to content
/Loan dunning cases

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

Loan dunning cases

Operations

Index the notifications of a dunning case

Request

Returns the notifications related to a dunning case.

Path
dunning_case_idstringrequired

The ID of the dunning case for which the notifications should be retrieved.

No request payload

Responses

LoanEngine.V1.ListDunningCaseNotificationsResponse

Bodyapplication/jsonArray [
idstringrequired

The ID of the dunning case.

Example: "de8d170b-321c-425b-830d-ed406cba6792"
created_atstring(datetime)required

The timestamp from when the dunning case notification was created.

Example: "2021-04-16T13:52:05Z"
titlestringrequired

The title of the dunning case notification.

typestringrequired

The type of the dunning case notification.

Enum"sddr_notification""partial_repayment_notification""full_repayment_notification""reminder""dunning_letter""pre_termination_letter""termination_letter""pre_collection_letter"
Example: "dunning_letter"
]
Response
application/json
[
  {
    "type": "dunning_letter",
    "title": "string",
    "id": "de8d170b-321c-425b-830d-ed406cba6792",
    "created_at": "2021-04-16T13:52:05Z"
  }
]

Retrieve a dunning case

Request

Returns the dunning case with the ID specified in the request URL.

Path
dunning_case_idstringrequired

The ID of the dunning case to be retrieved.

No request payload

Responses

Dunning Case

Bodyapplication/json
idstringrequired

The ID of the dunning case.

Example: "41c8d48c-4b73-4f5b-a7d0-5778e041b7c2"
statusstringrequired

The status of the dunning case.

Enum"new""dunning""pre_termination""terminated""closed""pre_collection""closed_matured"
Example: "new"
person_idstringrequired

The person ID of the customer associated with the loan and dunning case.

Example: "547a870b2c8461a3104559369d09265dcper"
loan_idstringrequired

The ID of the loan.

Example: "c13447d659db4cdcb450b977f8f25c57cloa"
billing_account_idstringrequired

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

Example: "1d0e52af0a62b4b44d8c54a87a7fc6a7cacc"
loan_account_idstringrequired

The account ID to which the loan is attached.

Example: "adc123a45d6d7cf8fbfeed537ba919d5cacc"
credit_reference_idstringrequired

The ID of the related credit line.

strategystringrequired

The dunning handling strategy to be applied to the case.

Enum"consumer""freelancer"
Example: "consumer"
total_overdue_amountSolarisToolkit.Web.Money (object)required
SolarisToolkit.Web.Money (object)
overdue_installment_amountSolarisToolkit.Web.Money (object)required
SolarisToolkit.Web.Money (object)
feesSolarisToolkit.Web.Money (object)required
SolarisToolkit.Web.Money (object)
deadlinestring(date)required

The date when the dunning case must be resolved.

Example: "2021-09-01"
last_sddr_datestring(date)required

The date of the last SEPA Direct Debit R-transaction.

Example: "2021-09-01"
Response
application/json
{
  "total_overdue_amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "strategy": "consumer",
  "status": "new",
  "person_id": "547a870b2c8461a3104559369d09265dcper",
  "overdue_installment_amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "loan_id": "c13447d659db4cdcb450b977f8f25c57cloa",
  "loan_account_id": "adc123a45d6d7cf8fbfeed537ba919d5cacc",
  "last_sddr_date": "2021-09-01",
  "id": "41c8d48c-4b73-4f5b-a7d0-5778e041b7c2",
  "fees": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "deadline": "2021-09-01",
  "credit_reference_id": "string",
  "billing_account_id": "1d0e52af0a62b4b44d8c54a87a7fc6a7cacc"
}

Index dunning cases

Request

Returns an array containing all the dunning cases 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[loan_account_id]string

Filters the returned dunning cases by a specific loan_account_id.

filter[person_id]string

Filters the returned dunning cases by a specific person ID.

filter[status]string

Filters the returned dunning cases by a specific status.

Enum"new""dunning""pre_termination""terminated""closed"
No request payload

Responses

LoanEngine.V1.ListDunningCasesResponse

Headers
totalinteger
Bodyapplication/jsonArray [
idstringrequired

The ID of the dunning case.

Example: "de8d170b-321c-425b-830d-ed406cba6792"
person_idstringrequired

The person ID of the customer associated with the loan and dunning case.

Example: "547a870b2c8461a3104559369d09265dcper"
loan_account_idstringrequired

The account ID to which the loan is attached.

Example: "adc123a45d6d7cf8fbfeed537ba919d5cacc"
statusstringrequired

The status of the dunning case.

Enum"new""dunning""pre_termination""terminated""closed""pre_collection""closed_matured"
Example: "dunning"
total_overdue_amountSolarisToolkit.Web.Money (object)required
SolarisToolkit.Web.Money (object)
]
Response
application/json
[
  {
    "total_overdue_amount": { … },
    "status": "dunning",
    "person_id": "547a870b2c8461a3104559369d09265dcper",
    "loan_account_id": "adc123a45d6d7cf8fbfeed537ba919d5cacc",
    "id": "de8d170b-321c-425b-830d-ed406cba6792"
  }
]

Consumer Loan

Operations