POST
/
v1
/
{instalmentId}
/
close
{
  "summary": "Closed instalment",
  "value": {
    "id": "5422311",
    "accountId": "4863511",
    "creationDate": "2025-06-05T13:16:10",
    "firstPayment": "2025-02-11",
    "lastPayment": "2030-08-25",
    "currency": "NOK",
    "totalAmount": 10000,
    "principalAmount": 10000,
    "interest": {
      "interestRate": 0,
      "effectiveRate": 0,
      "interestAmount": 0,
      "interestAmountBilled": 0
    },
    "interestPaidAmount": 0,
    "principalPaidAmount": 100,
    "dueAmount": 0,
    "overdueAmount": 0,
    "reversed": 9000,
    "fullRepaymentAmount": 9000,
    "status": "CLOSED",
    "lastUpdated": "2025-06-09T08:42:58",
    "transactionId": "98192911",
    "description": "Instalment plan for order #987",
    "planOptions": {
      "shift": 2,
      "type": "BUY_NOW_PAY_LATER"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Basic authentication is used to authenticate towards Enfuce API. It is described in more detail in RFC 7617.

Path Parameters

​
instalmentId
string
required

The instalment Id

Query Parameters

​
auditUser
string
required

The audit user to log the request

Response

Closed instalment

​
id
string

Instalment id

Example:

"678543"

​
instalmentOriginalId
string

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

Example:

"678544"

​
accountId
string
Maximum length: 255
Example:

"677654434532"

​
creationDate
string<date-time>

The creation date

​
firstPayment
string<date>

The day of the first payment

​
lastPayment
string<date>

The day of the last payment

​
currency
string

The currency of the instalment

Example:

"NOK"

​
effectiveRate
number

The effective rate. Please use interest.effectiveRate instead

Example:

10.46

​
totalAmount
number

The total amount of the instalment plan

Example:

1000

​
principalAmount
number

The principal amount

Example:

1000

​
feeAmount
number
deprecated

The fee amount. Please use interest.interestAmount instead

Example:

10

​
interest
object
​
paidAmount
number
deprecated

The paid amount. Please use interestPaidAmount instead

Example:

20

​
interestPaidAmount
number

The interest paid amount

Example:

20.57

​
principalPaidAmount
number

The principal paid amount

Example:

500

​
dueAmount
number

The due amount of the instalment plan

Example:

100

​
overdueAmount
number

The overdue amount of the instalment plan

Example:

200

​
writtenOffAmount
number
deprecated

The written-off amount. Please use reversed instead

Example:

1000

​
reversed
number

The reversed amount

Example:

1000

​
fullRepaymentAmount
number

The full repayment amount of the instalment plan

Example:

900

​
status
enum<string>

The status of the instalment plan

Available options:
INACTIVE,
WAITING,
OPEN,
PAID,
PAID_PARTIALLY,
OVERDUE,
REVISED,
CLOSED
​
lastUpdated
string<date-time>

The last updated date

​
transactionId
string<biginteger>
Example:

"8767653"

​
description
string

Optional text describing the instalment request

Maximum length: 255
Example:

"Instalment for product #4567"

​
planOptions
object

The paymentPlan.type field should be BUY_NOW_PAY_LATER.