PApaymentology
Group

Create Group Credit Limit

Changed on

The Create Group Credit Limit API enables effective management of credit limits for individual accounts or groups of accounts. Any account associated with the credit limit group will inherit the specified limits.

post/pws/pws_apply_group_credit_limit/

Request

  • Base URL
    https://api.uat.paymentology.com/ppws/api
  • URL
    https://api.uat.paymentology.com/ppws/api/pws/pws_apply_group_credit_limit/
  • Auth
    none declared

Request body

api_call_unique_identifierstring required

Unique number that must be passed at each API request. Identifier to make each API request unique

auto_dec_fixednumber required

Fixed Auto-decrease in the account's Billing Currency

auto_dec_logicstring 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_percnumber double required

Auto-decrease in Percents of the CURRENT credit limit

auto_dec_req_credit_ranking_thresholdinteger required

Credit ranking of the cardholder must be SMALLER than the threshold (-1 means NOT IMPORTANT)

auto_dec_req_full_bc_amount_paid_partially_nointeger required

Number of consequtive billing cycles where the amount was paid off only partially (0 means NOT IMPORTANT)

auto_dec_req_off_time_payments_nointeger required

Number of consequtive off-time payments (0 means NOT IMPORTANT)

auto_decrease_frequencystring 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_fixednumber required

Fixed Auto-increase in the account's Billing Currency

auto_inc_logicstring 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_percnumber double required

Auto-increase in Percents of the CURRENT credit limit

auto_inc_req_credit_ranking_thresholdinteger required

Credit ranking of the cardholder must be GREATER than the threshold (-1 means NOT IMPORTANT)

auto_inc_req_full_bc_amount_paid_off_nointeger required

Number of consequtive billing cycles where the full amount was paid off (0 means NOT IMPORTANT)

auto_inc_req_on_time_payments_nointeger required

Number of consequtive on-time payments (0 means NOT IMPORTANT)

auto_increase_frequencystring 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_idinteger required

Unique identifier for the client which Paymentology will provide at outset

group_idinteger required

group Id

mcc_codeinteger required

MCC Code

mcc_groupstring required

MCC group

merchant_type_categoryinteger required

Merchant Type Category

overdraft_fixednumber required

Overdraft in fixed available in the given Merchant Category

overdraft_logicstring 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_percnumber double required

Overdraft in Percents available in the given Merchant Category

user_idstring

User Id of the Customer who triggered the API request.

remarksstring

Remarks for API request

prod_idinteger

product Id

credit_limit_amountnumber

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_amtboolean

Indicator if the interest owed is counted against the available credit line

auto_inc_req_high_net_worth_indicatorboolean

High Net Worth indicator (NULL means NOT IMPORTANT)

auto_dec_req_high_net_worth_indicatorboolean

High Net Worth indicator (NULL means NOT IMPORTANT)

credit_limit_percent_of_generalnumber

merchant specific credit limit that is percent of general credit limit

Example request

{
  "api_call_unique_identifier": "438574845790657485",
  "auto_dec_fixed": 1,
  "auto_dec_logic": "MAX",
  "auto_dec_perc": 1,
  "auto_dec_req_credit_ranking_threshold": 2,
  "auto_dec_req_full_bc_amount_paid_partially_no": 1,
  "auto_dec_req_off_time_payments_no": 1,
  "auto_decrease_frequency": "N",
  "auto_inc_fixed": 1,
  "auto_inc_logic": "SUM",
  "auto_inc_perc": 1,
  "auto_inc_req_credit_ranking_threshold": 1,
  "auto_inc_req_full_bc_amount_paid_off_no": 1,
  "auto_inc_req_on_time_payments_no": 1,
  "auto_increase_frequency": "N",
  "client_id": 760131,
  "group_id": 2,
  "mcc_group": "0",
  "merchant_type_category": 1,
  "overdraft_fixed": 1,
  "overdraft_logic": "SUM",
  "overdraft_perc": 1,
  "credit_limit_amount": 1
}

Response

Successful Response

Example response

{
  "header": {
    "error_desc": "success"
  },
  "body": {
    "message": "Credit Limit Set Successfully for given account/card"
  }
}

Changes