Sign in

v1

latestOpenAPI 3.0.02026-07-242035712.0 MB
Credit interest

Activate Product Interest

This web service applies interests to product

post/pws/pws_cr_interest_current_product_create/

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 from which interest will be applied

interest_rate_fixednumber 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_gracenumber required

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

interest_rate_idinteger required

Interest Template Id for that client

interest_rate_logicstring 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_gracestring 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_percnumber double required
<p>Interest in Percents of the balance owed. </br>Default:0.00</p>
interest_rate_perc_gracenumber double required

Interest in Percents of the balance owed during the Grace Period

prod_idinteger required

prod_id

user_idstring

User Id of the Customer who triggered the API request.

remarksstring

Remarks for API request

is_defaultboolean

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_elevatednumber 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_elevatednumber
<p>Elevated (Penalty) Interest applied [For each day of the Late Payments].</br>Default:0.00</p>
interest_rate_logic_elevatedstring
<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_percnumber double

Minimum interest charged in Percents of the balance owed

interest_rate_min_fixednumber

Minimum interest charged

interest_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>
interest_rate_max_percnumber double

Maximum interest charged in Percents of the balance owed

interest_rate_max_fixednumber

Maximum Interest charged

interest_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>

Example request

{
  "api_call_unique_identifier": "438574845790657485",
  "client_id": 760131,
  "effective_date": "2021-08-20",
  "interest_rate_fixed": 1,
  "interest_rate_fixed_grace": 1,
  "interest_rate_id": 1,
  "interest_rate_logic": "SUM",
  "interest_rate_logic_grace": "SUM",
  "interest_rate_perc": 1,
  "prod_id": 261
}

Response

Successful Response

Example response

{
  "header": {
    "error_desc": "success"
  },
  "body": {
    "message": "Interest Rate Id 58 applied to product 261 successfully"
  }
}