v1

latestOpenAPI 3.0.32026-07-26208618579.9 KB

Instalment Operations

Get instalment plans for a given account

get/v1/account/{accountId}

Path parameters

accountIdstring required

The account id to instalment plans

Query parameters

auditUserstring required

The audit user to log the request

pageinteger

Current page

sizeinteger

How many entries should be returned per page, default is 30. Cannot be more than 100.

filterstring

Filter for instalment status. Supported operations: eq, or. Example: (status eq WAITING or status eq OVERDUE) Note: You must URL-encode parentheses and spaces.

Response

List of instalments for the given account

Example response

{
  "pagination": {
    "page": 1,
    "pages": 7,
    "elements": 15,
    "size": 1
  },
  "data": [
    {
      "id": "678543",
      "instalmentOriginalId": "678544",
      "accountId": "1234567890",
      "currency": "EUR",
      "effectiveRate": 10.46,
      "totalAmount": 1000,
      "principalAmount": 1000,
      "feeAmount": 10,
      "interest": {
        "interestRate": 9.9,
        "effectiveRate": 10.46,
        "interestAmount": 90,
        "interestAmountBilled": 10
      },
      "paidAmount": 20,
      "interestPaidAmount": 20.57,
      "principalPaidAmount": 500,
      "dueAmount": 100,
      "overdueAmount": 200,
      "writtenOffAmount": 1000,
      "reversed": 1000,
      "fullRepaymentAmount": 900,
      "transactionId": "8767653",
      "description": "Instalment for product #4567",
      "planOptions": {
        "shift": 2
      }
    }
  ]
}