PApaymentology
Fees

Update Group Fee

Changed on

This web service update fees for group

post/pws/pws_fee_current_group_update/

Request

  • Base URL
    https://api.uat.paymentology.com/ppws/api
  • URL
    https://api.uat.paymentology.com/ppws/api/pws/pws_fee_current_group_update/
  • 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

client_idinteger required

Unique identifier for the client which Paymentology will provide at outset

effective_datestring required

Effective Date

fee_applied_to'TXN,BLC,ANN,DAY,MAN,SPE' required
<p>Fee that is applied to.</br>possible options are:</p><ul><li>TXN: Transaction</li> <li>BLC: Billing Cycle (Period)</li> <li>ANN: Annually</li> <li>DAY: Daily (Computed during the overnight computational cycle)</li> <li>MAN: Card Event Fee/Charge Fee Api</li> <li>SPE: Special Event Fee</li></ul>
fee_basisinteger required

This parameter regulates in which case to apply the fee (of course, provided the rule is triggered):

<ul><li>1: Apply only if the transaction is approved</li> <li>2: Apply only if the transaction is declined</li> <li>3: Apply only mo matter the transaction is approved or declined</li> <li>0: Irrelevant: The rule is not a subject for a fee (fee_id IS NULL)</li></ul>
fee_idinteger required

Fee Template Id

fee_rate_fixednumber required
<p>Fixed fee that is not relative to amount_referenced (expressed in the account's billing currency).</br> Default:0.00</p>
fee_rate_fixed_gracenumber required

Fixed charge Rate in the account's Billing Currency during the Grace Period

fee_rate_logicstring required
<p>Relation between charge 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>
fee_rate_logic_gracestring required
<p>Relation between fee 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>
fee_rate_percnumber double required
<p>Fee in Percents of the balance owed. </br>Default:0.00</p>
fee_rate_perc_gracenumber double required

Fee in Percents of the balance owed during the Grace Period

group_idinteger required

Group Id

user_idstring

User Id of the Customer who triggered the API request.

remarksstring

Remarks for API request

fee_rate_perc_elevatednumber double
<p>Elevated (Penalty) Fee in Percents of the balance owed [For each day of the Late Payments].</br>Default:0.00</p>
fee_rate_fixed_elevatednumber
<p>Elevated (Penalty) fee applied [For each day of the Late Payments].</br>Default:0.00</p>
fee_rate_logic_elevatedstring
<p>Relation between elevated fee 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>
fee_rate_min_percnumber double

Minimum charge charged in Percents of the balance owed

fee_rate_min_fixednumber

Minimum charge charged

fee_rate_min_logicstring
<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>
fee_rate_max_percnumber double

Maximum fee charged in Percents of the balance owed

fee_rate_max_fixednumber

Maximum fee charged

fee_rate_max_logicstring
<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>
rule_idinteger

Rule Id

Example request

{
  "api_call_unique_identifier": "438574845790657485",
  "client_id": 760131,
  "effective_date": "2020-11-20 11:12:13",
  "fee_applied_to": "TXN",
  "fee_basis": 1,
  "fee_id": 1,
  "fee_rate_fixed": 1,
  "fee_rate_fixed_grace": 1,
  "fee_rate_logic": "SUM",
  "fee_rate_logic_grace": "SUM",
  "fee_rate_perc": 1,
  "fee_rate_perc_grace": 1,
  "group_id": 1
}

Response

Successful Response

Example response

{
  "header": {
    "error_desc": "success"
  },
  "body": {
    "message": "Fee Configuration Updated successfully for credit group 1"
  }
}

Changes