---
title: "Get Group Credit Limit"
method: POST
path: "/pws/pws_get_group_credit_limit/"
tags: ["Group"]
---

# Get Group Credit Limit

`POST /pws/pws_get_group_credit_limit/`

## Request

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

Retrieve the credit limit settings, including overdraft settings (if applicable) by calling this endpoint.

## Request body

- PwsGroupIdModel
  - `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
  - `user_id` string: User Id of the Customer who triggered the API request.
  - `remarks` string: Remarks for API request

## Response `200`

Successful Response

- GroupCreditTemplateResponse
  - `header` GroupCreditHeader
    - `error_id` integer: error id
    - `error_desc` string: error message
  - `body` GroupCreditBody
    - `api_call_unique_identifier` string, required: Unique number that must be passed at each API request. Identifier to make each API request unique
    - `auto_dec_fixed` number, required: Fixed Auto-decrease in the account's Billing Currency
    - `auto_dec_logic` string, required: Relation between Auto-decrease amounts computed based on percent and fixed amount: -- SUM: Sum of them -- MIN: Minimum of two amounts -- MAX: Maximum of two amounts -- AVG: Average of two amounts
    - `auto_dec_perc` number, double, required: Auto-decrease in Percents of the CURRENT credit limit
    - `auto_dec_req_credit_ranking_threshold` integer, required: Credit ranking of the cardholder must be SMALLER than the threshold (-1 means NOT IMPORTANT)
    - `auto_dec_req_full_bc_amount_paid_partially_no` integer, required: Number of consequtive billing cycles where the amount was paid off only partially (0 means NOT IMPORTANT)
    - `auto_dec_req_off_time_payments_no` integer, required: Number of consequtive off-time payments (0 means NOT IMPORTANT)
    - `auto_decrease_frequency` string, required: <p>Automatic decrease frequency in case the criteria is met.</br>possible options are:</p> <ul><li>N: Never, Auto-Decrease is disabled</li> <li>M: Monthly</li> <li>Q: Quarterly</li> <li>A: Annually</li></ul>
    - `auto_inc_fixed` number, required: Fixed Auto-increase in the account's Billing Currency
    - `auto_inc_logic` string, required: <p>Relation between Auto-increase amounts computed based on percent and fixed amount.</br>possible conditions 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>
    - `auto_inc_perc` number, double, required: Auto-increase in Percents of the CURRENT credit limit
    - `auto_inc_req_credit_ranking_threshold` integer, required: Credit ranking of the cardholder must be GREATER than the threshold (-1 means NOT IMPORTANT)
    - `auto_inc_req_full_bc_amount_paid_off_no` integer, required: Number of consequtive billing cycles where the full amount was paid off (0 means NOT IMPORTANT)
    - `auto_inc_req_on_time_payments_no` integer, required: Number of consequtive on-time payments (0 means NOT IMPORTANT)
    - `auto_increase_frequency` string, required: <p>Automatic increase frequency in case the criteria is met.</br>possible options are:</p> <ul><li>N: Never, Auto-Increase is disabled</li> <li>M: Monthly</li> <li>Q: Quarterly</li> <li>A: Annually</li></ul>
    - `client_id` integer, required: Unique identifier for the client which Paymentology will provide at outset
    - `group_id` integer, required: group Id
    - `mcc_code` integer, required: MCC Code
    - `mcc_group` string, required: MCC group
    - `merchant_type_category` integer, required: Merchant Type Category
    - `overdraft_fixed` number, required: Overdraft in fixed available in the given Merchant Category
    - `overdraft_logic` string, required: <p>Relation between overdraft amounts computed based on percent and fixed amount:</p> possible options are:<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>
    - `overdraft_perc` number, double, required: Overdraft in Percents available in the given Merchant Category
    - `user_id` string: User Id of the Customer who triggered the API request.
    - `remarks` string: Remarks for API request
    - `prod_id` integer: product Id
    - `credit_limit_amount` number: Total size of the credit limit (credit line) established for the card in the given Merchant Category and so on [in BILLING CURRENCY]
    - `include_interest_in_available_amt` boolean: Indicator if the interest owed is counted against the available credit line
    - `auto_inc_req_high_net_worth_indicator` boolean: High Net Worth indicator (NULL means NOT IMPORTANT)
    - `auto_dec_req_high_net_worth_indicator` boolean: High Net Worth indicator (NULL means NOT IMPORTANT)
    - `credit_limit_percent_of_general` number: merchant specific credit limit that is percent of general credit limit

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