---
title: "Get Current Interests"
method: POST
path: "/pws/pws_cr_get_current_interest_template/"
tags: ["Credit interest"]
---

# Get Current Interests

`POST /pws/pws_cr_get_current_interest_template/`

This web service gets the details of a interest that was applied and is still active

## Request body

- GetCurrentInterestTemplate
  - `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
  - `interest_rate_id` integer — Interest Template Id

## Response `200`

Successful Response

- GetInterestTemplateResponse
  - `header` GetInterestTemplateHeader
    - `error_id` integer — error id
    - `error_desc` string — error message
  - `body` GetInterestTemplateBody
    - `amount_referenced` string, required — <p>Amount Referenced,can be any one of the following:</p><ul><li>TXN:transaction,OWD:Amount Owed,ATA: Aggregated amount of all transactions during the day, billing cycle, or annual (depending on the value of applied_to)</li> <li>ATD: Aggregated amount of debit transactions during the day, billing cycle, or annual (depending on the value of applied_to)</li><li>ATC: Aggregated amount of credit transactions during the day, billing cycle, or annual (depending on the value of applied_to)</li></ul>
    - `api_call_unique_identifier` string, required — Unique number that must be passed at each API request. Identifier to make each API request unique
    - `applied_to` string, required — <p>Interest Applied to:</p><ul><li>TXN:transaction</li><li>DAY:Daily</li><li>BLC:Balance Cycle</li><li>ANN:Annually</li></ul>
    - `client_id` integer, required — Unique identifier for the client which Paymentology will provide at outset
    - `effective_date` string, required — Effective Date
    - `interest_rate_descr` string, required — Description of Interest Rate
    - `interest_rate_id` integer, required — Interest Rate Id
    - `interest_rate_logic` string, required — <p>Relation between interest rates computed based on APR and fixed amount.</br>possible options are:</p><ul><li>SUM: Sum of them</li> <li>MIN: Minimum of two amounts</li> <li>MAX: Maximum of two amounts</li> <li>AVG: Average of two amounts</li></ul>
    - `interest_rate_logic_elevated` string, required — <p>Relation between elevated interest rates computed based on APR and fixed amount.</br>possible options are:</p> <ul><li>SUM: Sum of them</li> <li>MIN: Minimum of two amounts</li> <li>MAX: Maximum of two amounts</li> <li>AVG: Average of two amounts</li></ul>
    - `interest_rate_logic_grace` string, required — <p>Relation between interest rates for the grace period computed based on APR and fixed amount.</br>possible options are></p> <ul><li>SUM: Sum of them</li> <li>MIN: Minimum of two amounts</li> <li>MAX: Maximum of two amounts</li> <li>AVG: Average of two amounts</li></ul>
    - `interest_rate_max_logic` string, required — <p> Relation between maximum interest rates computed based on percents and fixed amount.</br>possible options are:</p> <ul><li>SUM: Sum of them</li> <li>MIN: Minimum of two amounts</li> <li>MAX: Maximum of two amounts</li> <li>AVG: Average of two amounts</li></ul>
    - `interest_rate_max_perc` number, double, required — Maximum interest charged in Percents of the balance owed
    - `interest_rate_min_logic` string, required — <p>Relation between minimum interest rates computed based on percents and fixed amount.</br>possible options are:</p> <ul><li>SUM: Sum of them</li> <li>MIN: Minimum of two amounts</li> <li>MAX: Maximum of two amounts</li> <li>AVG: Average of two amounts</li></ul>
    - `interest_rate_min_perc` number, float, required — Minimum interest charged in Percents of the balance owed
    - `interest_rate_note` string, required — interest Note
    - `interest_rate_perc` number, double, required — Interest Rate APR in Percents of the balance owed,Default=0.00
    - `interest_rate_perc_elevated` number, double, required — Elevated (Penalty) interest Rate APR in Percents of the balance owed [For each day of the Late Payments],default:0.00
    - `interest_rate_perc_grace` number, double, required — Interest Rate APR in Percents of the balance owed during the Grace Period
    - `method` integer, required — <p>Method of interest Computation.</br>possible options are:</p> <ul><li>1: Average Daily Balance Method</li> <li>2: Previous Balance Method</li> <li>3: Adjusted Balance Method</li></ul>
    - `start_counting_from` string, required — <p>When should we start counting interest on the financial activity.</br>Options are:<ul><li>TXN: From the transaction date / fee computed</li><li>SET: From the settlement date / fee settled</li></ul></p>
    - `user_id` string — User Id of the Customer who triggered the API request.
    - `remarks` string — Remarks for API request
    - `special_actions` string — Function call for a function making special actions
    - `condition_function_call` string — condition function call that should be call when we need to put some condition
    - `grace_period_duration` integer — <ul><li>0: The interest is counted from the transaction date</li><li>1: Normal grace period (pay by the due date to get the interest waived)</li><li>n > 1: Extended grace period for n billing cycles (including the current one)</li></ul>

## Other responses

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

---

[API](https://skmtc.net/paymentology/apis/payapi-docs.md) · [All operations](https://skmtc.net/paymentology/apis/payapi-docs/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/paymentology/payapi-docs/revisions/a675891b0365/schema)