---
title: "Get instalment plans for a given account"
method: GET
path: "/v1/account/{accountId}"
tags: ["Instalment Operations"]
---

# Get instalment plans for a given account

`GET /v1/account/{accountId}`

## Path parameters

- `accountId` string, required

## Query parameters

- `auditUser` string, required
- `page` integer
- `size` integer
- `filter` string

## Response `200`

List of instalments for the given account

- GetInstalmentPaginatedResponse
  - `pagination` Pagination
    - `page` integer — Current page
    - `pages` integer — Total number of pages
    - `elements` integer — Total number of objects
    - `size` integer — Page size
  - `data` GetInstalmentResponse[]
    - `id` string — Instalment id
    - `instalmentOriginalId` string — The id which links the original instalment and the new instalment resulted after revise process
    - `accountId` string — The account id card is linked to
    - `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 — A valid ISO 4217 currency code
    - `effectiveRate` number — The effective rate. Please use `interest.effectiveRate` instead
    - `totalAmount` number — The total amount of the instalment plan
    - `principalAmount` number — The principal amount
    - `feeAmount` number — The fee amount. Please use `interest.interestAmount` instead
    - `interest` InterestDetails
      - `interestRate` number — The interest rate
      - `effectiveRate` number — The effective rate. Please use `interest.effectiveRate` instead
      - `interestAmount` number — The predicted interest
      - `interestAmountBilled` number — The interest amount billed
    - `paidAmount` number — The paid amount.
    - `interestPaidAmount` number — The interest paid amount
    - `principalPaidAmount` number — The principal paid amount
    - `dueAmount` number — The due amount of the instalment plan
    - `overdueAmount` number — The overdue amount of the instalment plan
    - `writtenOffAmount` number — The written-off amount. Please use `reversed` instead
    - `reversed` number — The reversed amount
    - `fullRepaymentAmount` number — The full repayment amount of the instalment plan
    - `status` 'CLOSED' | 'OPEN' | 'OVERDUE' | 'PAID' | 'PAID_PARTIALLY' | 'WRITE-OFF'
    - `lastUpdated` string, date-time — The last updated date
    - `transactionId` string, biginteger
    - `description` string — Optional text describing the instalment request
    - `planOptions` union
      - object — The `paymentPlan.type` field should be BUY_NOW_PAY_LATER.
        - `type` 'BUY_NOW_PAY_LATER' | 'INTEREST_FREE' | 'FIXED_INTEREST', required — The type of instalment plan.
        - `shift` integer — The number of months for which the plan is shifted. Must be in range [0..24]
      - BaseInterestOptionsResponse
        - `paymentPlan` object, required
          - `tenor` integer, required — Number of instalments
          - `portionAmount` number — The portion amount
      - BaseInterestOptionsResponse
        - `paymentPlan` object, required
          - `tenor` integer, required — Number of instalments
          - `portionAmount` number — The portion amount

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Account not found
- `500` — Internal server error

---

[API](https://skmtc.net/enfuce/apis/transfer-api.md) · [All operations](https://skmtc.net/enfuce/apis/transfer-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/enfuce/transfer-api/revisions/dc4a41118f80/schema)