Get instalment plans for a given account

GET

account

{accountId}

curl --request GET \
  --url 'https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/instalment/v1/account/{accountId}' \
  --header 'Authorization: Basic <encoded-value>'

{
  "pagination": {
    "page": 1,
    "pages": 7,
    "elements": 15,
    "size": 1
  },
  "data": [
    {
      "id": "678543",
      "instalmentOriginalId": "678544",
      "accountId": "677654434532",
      "creationDate": "2023-11-07T05:31:56Z",
      "firstPayment": "2023-12-25",
      "lastPayment": "2023-12-25",
      "currency": "NOK",
      "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,
      "status": "INACTIVE",
      "lastUpdated": "2023-11-07T05:31:56Z",
      "transactionId": "8767653",
      "description": "Instalment for product #4567",
      "planOptions": {
        "type": "BUY_NOW_PAY_LATER",
        "shift": 2
      }
    }
  ]
}

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

accountId

string

required

The account id to instalment plans

Query Parameters

auditUser

string

required

The audit user to log the request

page

integer

default:0

Current page

Required range: x >= 0

size

integer

default:30

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

Required range: 1 < x < 100

filter

string

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

pagination

object

Show child attributes

pagination.page

integer

Current page

Example:

1

pagination.pages

integer

Total number of pages

Example:

7

pagination.elements

integer

Total number of objects

Example:

15

pagination.size

integer

Page size

Example:

1

data

object[]

Show child attributes

data.id

string

Instalment id

Example:

"678543"

data.instalmentOriginalId

string

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

Example:

"678544"

data.accountId

string

Maximum string length: 255

Example:

"677654434532"

data.creationDate

string<date-time>

The creation date

data.firstPayment

string<date>

The day of the first payment

data.lastPayment

string<date>

The day of the last payment

data.currency

string

The currency of the instalment

Example:

"NOK"

data.effectiveRate

number

deprecated

The effective rate. Please use interest.effectiveRate instead

Example:

10.46

data.totalAmount

number

The total amount of the instalment plan

Example:

1000

data.principalAmount

number

The principal amount

Example:

1000

data.feeAmount

number

deprecated

The fee amount. Please use interest.interestAmount instead

Example:

10

data.interest

object

Show child attributes

data.interest.interestRate

number

The interest rate

Example:

9.9

data.interest.effectiveRate

number

The effective rate. Please use interest.effectiveRate instead

Example:

10.46

data.interest.interestAmount

number

The predicted interest

Example:

90

data.interest.interestAmountBilled

number

The interest amount billed

Example:

10

data.paidAmount

number

deprecated

The paid amount. Please use interestPaidAmount instead

Example:

20

data.interestPaidAmount

number

The interest paid amount

Example:

20.57

data.principalPaidAmount

number

The principal paid amount

Example:

500

data.dueAmount

number

The due amount of the instalment plan

Example:

100

data.overdueAmount

number

The overdue amount of the instalment plan

Example:

200

data.writtenOffAmount

number

deprecated

The written-off amount. Please use reversed instead

Example:

1000

data.reversed

number

The reversed amount

Example:

1000

data.fullRepaymentAmount

number

The full repayment amount of the instalment plan

Example:

900

data.status

enum<string>

The status of the instalment plan

Available options:

INACTIVE,

WAITING,

OPEN,

PAID,

PAID_PARTIALLY,

OVERDUE,

REVISED,

CLOSED

data.lastUpdated

string<date-time>

The last updated date

data.transactionId

string<biginteger>

Example:

"8767653"

data.description

string

Optional text describing the instalment request

Maximum string length: 255

Example:

"Instalment for product #4567"

data.planOptions

BUY_NOW_PAY_LATER · object

The paymentPlan.type field should be BUY_NOW_PAY_LATER.

BUY_NOW_PAY_LATER
INTEREST_FREE
FIXED_INTEREST

Show child attributes

data.planOptions.type

enum<string>

required

The type of instalment plan.

Available options:

BUY_NOW_PAY_LATER,

INTEREST_FREE,

FIXED_INTEREST

data.planOptions.shift

integer

The number of months for which the plan is shifted.

Example:

2

⌘I

Get instalment plans for a given account

curl --request GET \
  --url 'https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/instalment/v1/account/{accountId}' \
  --header 'Authorization: Basic <encoded-value>'

{
  "pagination": {
    "page": 1,
    "pages": 7,
    "elements": 15,
    "size": 1
  },
  "data": [
    {
      "id": "678543",
      "instalmentOriginalId": "678544",
      "accountId": "677654434532",
      "creationDate": "2023-11-07T05:31:56Z",
      "firstPayment": "2023-12-25",
      "lastPayment": "2023-12-25",
      "currency": "NOK",
      "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,
      "status": "INACTIVE",
      "lastUpdated": "2023-11-07T05:31:56Z",
      "transactionId": "8767653",
      "description": "Instalment for product #4567",
      "planOptions": {
        "type": "BUY_NOW_PAY_LATER",
        "shift": 2
      }
    }
  ]
}