---
title: "Get Installment Template"
method: POST
path: "/pws/pws_get_installment_template"
tags: ["Installment"]
---

# Get Installment Template

`POST /pws/pws_get_installment_template`

## Request

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

This web service allows to get installment template

## Request body

- PwsGetInstallmentTemplateModel
  - `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
  - `template_id` integer: Template Id

## Response `200`

Successful Response

- GetInstallmentTemplateResponse
  - `header` GetContractTemplateHeader
    - `error_id` integer: error id
    - `error_desc` string: error message
  - `body` GetContractTemplateBody
    - `end_date` string, required: Installment Offer End Date
    - `prod_id` string, required: Product Id that can have feature of installment
    - `start_date` string, required: Installment Offer Start Date
    - `title` string, required: Title for the Installment Template
    - `template_id` integer: Installment template
    - `cre_dt` string: Installment Created Date
    - `update_dt` string: Installment Updated Date
    - `installment_type` string: Installment Type.</br> Following are the type of installment:<ul><li>ST:Scheme Transaction</li><li>SB:Statement Balance</li><li>OB:Outstanding Balance</li><li>NS: Non-Schema</li></ul>
    - `processing_fee_perc` number: Installment Processing Fee in Percent
    - `processing_fee_fixed` number: Installment Processing Fee in Fixed
    - `processing_fee_logic` string: Installment Processing Fee Logic.</br>Fee Logic can be one of the following:<ul><li>SUM: Sum of the two</li><li>AVG: Average of the two</li><li>MIN: Minimum of the two</li><li>MAX:Maximum of the two</li></ul>
    - `cancellation_fee_perc` number: Installment Cancellation Fee in Percent
    - `cancellation_fee_fixed` number: Installment Cancellation Fee in Fixed
    - `cancellation_fee_logic` string: Installment Cancellation Fee Logic.</br>Fee Logic can be one of the following:<ul><li>SUM: Sum of the two</li><li>AVG: Average of the two</li><li>MIN: Minimum of the two</li><li>MAX:Maximum of the two</li></ul>
    - `allow_fee_override` boolean: This field is used to override the existing template fee with the fee selected when offering installment
    - `allow_interest_override` boolean: This field is used to override the existing template interest with the interest selected when offering installment
    - `allow_period_override` boolean: This field is used to override the existing template period with the period selected when offering installment
    - `total_value_formula` integer: Field that indicates whether fee,interest,principal or margin is to be included when converting to installment
    - `period` integer: Cycle upto when the installment is to be implemented
    - `scheme_profile_id` string: Installment Scheme Profile Id
    - `status` boolean: Installment Status
    - `installment_method` integer: Installment Method.</br> There are two methods:<ul><li>1: Flat</li><li>2: Reducing</li></ul>
    - `interest_rate` number: Interest Rate that is applied during the installment

## 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_template/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)