Sign in

v1

latestOpenAPI 3.0.02026-07-242035712.0 MB
Credit interest

Create Interest Template

This web service creates a new credit interest. The interest will still need to be applied to a context using Activate interest

post/pws/pws_cr_create_interest_template/

Request body

amount_referencedstring required
<p>The amount percentage is counted from.</br> .possible options are;<ul><li>N/A: Amount is irrelevant</li><li>TXN: transaction</li><li>OWD: Amount owed</li><li>ATA: Aggregated amount of all transactions during the day, billing cycle, or annual (depending on the value of applied_to)</li><li>ATD: Aggregated amount of debit transactions during the day, billing cycle, or annual (depending on the value of applied_to)</li><li>ATC: Aggregated amount of credit transactions during the day, billing cycle, or annual (depending on the value of applied_to)</li></ul>
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

interest_rate_descrstring required

Interest Rate Description

interest_rate_notestring required

Interest Rate Note

methodinteger required

Interest Method.</br>There are 5 interest methods out of which method (1 to 5) are in implementation.</br>Following are the type of method that can be used:<ul><li>1--> Average Daily Balance Method</li><li>2-->Previous Balance Method</li><li>3-->Adjusted Balance Method</li><li>4-->Murahaba-Markup Method</li><li>5-->Average Daily Balance AMEX Method</li></ul>

priorityinteger required

Interest Priority.Lowest the number Highest the priority

user_idstring

User Id of the Customer who triggered the API request.

remarksstring

Remarks for API request

condition_function_callstring
<p>Condition Function Call (to determine if the interest should be applied or not.</br>Empty string means that the interest can be applied unconditionally</p>)
special_actionsstring

Function call for a function making special actions

grace_period_cycles_nointeger

Defines the interest that is to be computed by either due date or grace period.</br>possible value are:<ul><li>0-->Accure Interest From Transaction Date</li><li>1--> Normal Grace Period(pay by due date)</li><li>2--> Extended Grace Period</li></ul>

start_counting_from'SET,TXN'

Interest computed should be counted from. Default value is 'SET'.</br><ul><li>SET-->From the settlement date/ fee settled</li><li> TXN--> From the transaction date/ fee computed</li></ul>

Example request

{
  "amount_referenced": "OWD",
  "api_call_unique_identifier": "438574845790657485",
  "client_id": 760131,
  "effective_date": "2020-11-19",
  "interest_rate_descr": "15_Interest",
  "interest_rate_note": "15_Interest",
  "method": 1,
  "priority": 1000,
  "condition_function_call": "</>",
  "start_counting_from": "SET"
}

Response

Successful Response

Example response

{
  "header": {
    "error_desc": "success"
  },
  "body": {
    "interest_rate_id": 11
  }
}