---
title: "Offer Installment"
method: POST
path: "/pws/pws_offer_installment"
tags: ["Installment"]
---

# Offer Installment

`POST /pws/pws_offer_installment`

## Request

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

This web service offer installment plan to client

## Request body

- PwsOfferInstallmentModel
  - `acc_id` integer, required: Account Id
  - `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
  - `template_id` integer, required: Installment Template Id
  - `user_id` string: User Id of the Customer who triggered the API request.
  - `remarks` string: Remarks for API request
  - `rid` integer: Transaction RID which we are converting to installment.</br>It is optional when template is defined for 'OB','SB' and 'NS for fee'.And it is required when template is defined for 'ST' and 'NS with Financial Debit Transaction'
  - `principal_value` number: Total Amount which is to be converted as installment
  - `interest_rate` number: Interest Rate that is to be applied for this installment only.</br>The value will only be used if the allow_interest_override value from the installment template is true
  - `processing_fee_fixed` number: Processing fee fixed that is to be applied for this installment only.</br>The value will only be used if the allow_fee_override value from the installment template is true
  - `processing_fee_perc` number: Processing fee percent that is to be applied for this installment only.</br>The value will only be used if the allow_fee_override value from the installment template is true
  - `processing_fee_logic` string: Processing fee logic that is to be applied for this installment only Valid values are 'SUM','AVG','MIN','MAX'.</br>The value will only be used if the allow_fee_override value from the installment template is true
  - `period` integer: Cycle duration for which the installment is to be implemented</br>The value will only be used if the allow_period_override value from the installment template is true

## Response `200`

Successful Response

- PwsOfferInstallmentResponse
  - `header` PwsOfferInstallmentResponseHeader
    - `error_id` integer: error id
    - `error_desc` string: error message
  - `body` PwsOfferInstallmentResponseBody
    - `installment_details` PwsInstallmentDetail
      - `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 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` PwsOfferInstallmentSchedule[]
      - `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_offer_installment/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)