---
title: "Get Group Interest History"
method: POST
path: "/pws/pws_cr_interest_history_group_get/"
tags: ["Credit interest"]
---

# Get Group Interest History

`POST /pws/pws_cr_interest_history_group_get/`

## Request

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

This web service gets the history of interests applied to the given group

## Request body

- PwsGetGroupInterestHistory
  - `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
  - `group_id` integer, required: group_id
  - `interest_rate_id` integer, required: interest_rate_id
  - `user_id` string: User Id of the Customer who triggered the API request.
  - `remarks` string: Remarks for API request

## Response `200`

Successful Response

- GetGroupInterestHistoryResponse
  - `header` GetGroupInterestHistoryResponseHeader
    - `error_id` integer: error id
    - `error_desc` string: error message
  - `body` GetGroupInterestHistoryResponseBody
    - `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
    - `effective_date` string, required: Effective Date from which interest will be applied
    - `interest_rate_descr` string, required
    - `interest_rate_fixed` number, required: <p>Fixed Interest that is not relative to amount_referenced (expressed in the account's billing currency).</br> Default:0.00</p>
    - `interest_rate_fixed_grace` number, required: Fixed charge Rate in the account's Billing Currency during the Grace Period
    - `interest_rate_id` integer, required: Interest Template Id for that client
    - `interest_rate_logic` string, required: <p>Relation between interest rates computed based on APR and fixed amount.</br>The value can be one of them:</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 for the grace period computed and fixed amount.</br> The value can be one of them:</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_perc` number, double, required: <p>Interest in Percents of the balance owed. </br>Default:0.00</p>
    - `interest_rate_perc_grace` number, double, required: Interest in Percents of the balance owed during the Grace Period
    - `user_id` string: User Id of the Customer who triggered the API request.
    - `remarks` string: Remarks for API request
    - `is_default` boolean: If it is default interest config.</br>If there are more than one interest config then there should be one default interest one.</br>If there is only one interest config, then it should be default one from the system
    - `interest_rate_perc_elevated` number, double: <p>Elevated (Penalty) Interest in Percents of the balance owed [For each day of the Late Payments].</br>Default:0.00</p>
    - `interest_rate_fixed_elevated` number: <p>Elevated (Penalty) Interest applied [For each day of the Late Payments].</br>Default:0.00</p>
    - `interest_rate_logic_elevated` string: <p>Relation between elevated interest rates computed based on APR and fixed amount.</br> The value can be one of them:</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, double: Minimum interest charged in Percents of the balance owed
    - `interest_rate_min_fixed` number: Minimum interest charged
    - `interest_rate_min_logic` string: <p>Relation between minimum charge rates computed based on percents and fixed amount.</br> The value can be one of them:</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: Maximum interest charged in Percents of the balance owed
    - `interest_rate_max_fixed` number: Maximum Interest charged
    - `interest_rate_max_logic` string: <p> Relation between maximum fee rates computed based on percents and fixed amount.</br> The value can be one of them:</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>
    - `group_id` integer: group_id
    - `seq_no` integer: seq_no
    - `change_event` string: change_event
    - `changed_dt` string, date-time: changed_dt

## Other responses

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

---

[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)