GET
/
v1
/
instalment
/
{instalmentId}
curl --request GET \
  --url https://integration-api-cat2./%7B{environment}%7D.ext.%7B{realm}%7D.cia.enfuce.com/instalment/v1/instalment/{instalmentId} \
  --header 'Authorization: Basic <encoded-value>'
{
  "instalmentId": "<string>",
  "instalmentOriginalId": "<string>",
  "creationDate": "2023-11-07T05:31:56Z",
  "firstPayment": "2023-12-25",
  "lastPayment": "2023-12-25",
  "currency": "<string>",
  "tenor": 123,
  "effectiveRate": "<string>",
  "totalAmount": "<string>",
  "principalAmount": "<string>",
  "feeAmount": "<string>",
  "paidAmount": "<string>",
  "principalPaidAmount": "<string>",
  "dueAmount": "<string>",
  "ovdAmount": "<string>",
  "writtenOffAmount": "<string>",
  "fullRepaymentAmount": "<string>",
  "status": "WAITING",
  "lastUpdated": "2023-11-07T05:31:56Z",
  "transactionId": "<string>"
}

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

200
application/json
Instalment
​
instalmentId
string

Instalment id

​
instalmentOriginalId
string

The instalment id

​
creationDate
string

The creation date

​
firstPayment
string

The day of the first payment

​
lastPayment
string

The day of the last payment

​
currency
string

The currency of the instalment

​
tenor
number

Number of instalments

​
effectiveRate
string

The effective rate

​
totalAmount
string

The total amount of the instalment plan

​
principalAmount
string

The principal amount

​
feeAmount
string

The fee amount

​
paidAmount
string

The paid amount

​
principalPaidAmount
string

The principal paid amount

​
dueAmount
string

The due amount of the instalment plan

​
ovdAmount
string

The over-due amount of the instalment plan

​
writtenOffAmount
string

The written-off amount

​
fullRepaymentAmount
string

The full-repayment amount of the instalment plan

​
status
enum<string>

The status of the instalment plan

Available options:
WAITING,
INACTIVE,
PREVIEW,
PREVIEW_CLOSED,
OPEN,
PAIDPART,
OVD,
PAID,
CLOSED,
WRITE-OFF,
REVISED,
WAIVED,
NOT_READY,
MOVED,
REJECTED,
SIMULATED,
EXTERNAL,
Z,
OUTSTAND,
OUTSTAND_COMPLETE
​
lastUpdated
string

The last updated date

​
transactionId
string
Change instalment plan tenor (number of instalments)Get Instalment by transactionId