---
title: "Get Installment Details"
method: POST
path: "/pws/pws_get_installment_details"
tags: ["Installment"]
---

# Get Installment Details

`POST /pws/pws_get_installment_details`

## Request

- Base URL: `https://api.uat.paymentology.com/ppws/api`
- URL: `https://api.uat.paymentology.com/ppws/api/pws/pws_get_installment_details`
- Auth: none declared

This web service allows to get installment plan details

## Request body

- PwsGetOfferedInstallmentModel
  - `api_call_unique_identifier` string, required: Unique number that must be passed at each API request. Identifier to make each API request unique
  - `client_id` integer, required: Unique identifier for the client which Paymentology will provide at outset
  - `user_id` string: User Id of the Customer who triggered the API request.
  - `remarks` string: Remarks for API request
  - `cu_id` integer: Customer Id
  - `ac_id` integer: Account Id
  - `token` integer: Token Id
  - `prod_id` integer: Product Id

## Response `200`

Successful Response

- GetOfferedInstallmentResponse
  - `header` GetOfferInstallmentHeader
    - `error_id` integer: error id
    - `error_desc` string: error message
  - `body` GetOfferInstallmentBody
    - `template_id` integer: Installment Template ID
    - `installment_id` integer: Installment ID
    - `client_id` integer: Client ID
    - `prod_id` integer: Product ID
    - `customer_id` integer: Customer ID
    - `account_id` integer: Account ID
    - `pr_tok` integer: Private Token
    - `tc_id` integer: Transaction rid/tc_id converted to installment
    - `status` string: Installment Status
    - `start_date` string, date-time: Installment Start Date
    - `end_date` string, date-time: Installment End Date
    - `principal_amount` number: Principal Amount
    - `installment_amount` number: Installment Amount
    - `interest_rate` number: Interest Rate
    - `processing_fee_perc` number: Processing fee perc
    - `processing_fee_fixed` number: Processing fee fixed
    - `processing_fee_logic` string: Processing fee logic
    - `period` integer: Installment Cycle
    - `cre_dt` string, date-time: Installment Created Date
    - `installment_schedules` GetInstallmentSchedule[]: Installment Schedules details
      - `schedule_id` integer: Installment Scheduled Id. AutoIncrement
      - `installment_id` integer: Installment ID
      - `seq_no` integer: Installment Period/Cycle No
      - `scheduled_dt` string, date-time: Installment Scheduled Date
      - `installment_amt` number: Installment Amount for that particular period/cycle
      - `status` integer: Installment Status. Indicate whether it is paid or unpaid

## Other responses

- `404`: Webservices does not exist
- `500`: Internal Server error

## Changes

- **2026-11-03** `73c2771493b1`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/paymentology/apis/payapi-docs/changes/pws/pws_get_installment_details/post.md)

---

[API](https://skmtc.dev/paymentology/apis/payapi-docs.md) - [All operations](https://skmtc.dev/paymentology/apis/payapi-docs/llms.txt) - [OpenAPI document](https://skmtc.dev/paymentology/apis/payapi-docs/revisions/73c2771493b1?raw)
