Create Interest Template

post

https://uat.banking.live:55555/ppws/api/pws/pws_cr_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

Body Params

amount_referenced

string

required

length between 0 and 3

^[N/A,TXN,OWD,ATA,ATD,ATC]{3}$

The amount percentage is counted from.
.possible options are;

N/A: Amount is irrelevant
TXN: transaction
OWD: Amount owed
ATA: Aggregated amount of all transactions during the day, billing cycle, or annual (depending on the value of applied_to)
ATD: Aggregated amount of debit transactions during the day, billing cycle, or annual (depending on the value of applied_to)
ATC: Aggregated amount of credit transactions during the day, billing cycle, or annual (depending on the value of applied_to)

api_call_unique_identifier

string

required

length between 1 and 40

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

client_id

int32

required

≥ 1

Unique identifier for the client which Paymentology will provide at outset

effective_date

string

required

length ≥ 1

\d{4}-\d{2}-\d{2}

Effective Date

interest_rate_descr

string

required

length ≥ 1

Interest Rate Description

interest_rate_note

string

required

length ≥ 1

Interest Rate Note

method

int32

required

1 to 5

Interest Method.
There are 5 interest methods out of which method (1 to 5) are in implementation.
Following are the type of method that can be used:

1--> Average Daily Balance Method
2-->Previous Balance Method
3-->Adjusted Balance Method
4-->Murahaba-Markup Method
5-->Average Daily Balance AMEX Method

priority

int32

required

0 to 32767

Interest Priority.Lowest the number Highest the priority

user_id

string

length between 0 and 50

User Id of the Customer who triggered the API request.

remarks

string

length between 0 and 200

Remarks for API request

condition_function_call

string

Condition Function Call (to determine if the interest should be applied or not.
Empty string means that the interest can be applied unconditionally

)

special_actions

string

Function call for a function making special actions

grace_period_cycles_no

int32

0 to 2

Defines the interest that is to be computed by either due date or grace period.
possible value are:

0-->Accure Interest From Transaction Date
1--> Normal Grace Period(pay by due date)
2--> Extended Grace Period

start_counting_from

string

enum

^[SET,TXN]{3}$

Interest computed should be counted from. Default value is 'SET'.

SET-->From the settlement date/ fee settled
TXN--> From the transaction date/ fee computed

Allowed:

Responses

404

Webservices does not exist

500

Internal Server error

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response