Sign in

v1

latestOpenAPI 3.0.32026-07-26208618579.9 KB
Instalment Operations

Close an existing instalment plan

post/v1/{instalmentId}/close

Path parameters

instalmentIdstring required

The instalment Id

Query parameters

auditUserstring required

The audit user to log the request

Response

Closed instalment

idstring

Instalment id

instalmentOriginalIdstring

The id which links the original instalment and the new instalment resulted after revise process

accountIdstring

The account id card is linked to

creationDatestring date-time

The creation date

firstPaymentstring date

The day of the first payment

lastPaymentstring date

The day of the last payment

currencystring

A valid ISO 4217 currency code

effectiveRatenumber

The effective rate. Please use interest.effectiveRate instead

totalAmountnumber

The total amount of the instalment plan

principalAmountnumber

The principal amount

feeAmountnumber

The fee amount. Please use interest.interestAmount instead

paidAmountnumber

The paid amount.

interestPaidAmountnumber

The interest paid amount

principalPaidAmountnumber

The principal paid amount

dueAmountnumber

The due amount of the instalment plan

overdueAmountnumber

The overdue amount of the instalment plan

writtenOffAmountnumber

The written-off amount. Please use reversed instead

reversednumber

The reversed amount

fullRepaymentAmountnumber

The full repayment amount of the instalment plan

status'CLOSED' | 'OPEN' | 'OVERDUE' | 'PAID' | 'PAID_PARTIALLY' | 'WRITE-OFF'
lastUpdatedstring date-time

The last updated date

transactionIdstring biginteger
descriptionstring

Optional text describing the instalment request

Example response

{
  "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
  }
}