API Reference
Client Login
  1. PayApi Docs
  2. Credit interest

Create Interest Template

post
https://api.uat.paymentology.com/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
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)
string
required
length between 1 and 40

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

int32
required
≥ 1

Unique identifier for the client which Paymentology will provide at outset

string
required
length ≥ 1
\d{4}-\d{2}-\d{2}

Effective Date

string
required
length ≥ 1

Interest Rate Description

string
required
length ≥ 1

Interest Rate Note

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

int32
required
0 to 32767

Interest Priority.Lowest the number Highest the priority

string
length between 0 and 50

User Id of the Customer who triggered the API request.

string
length between 0 and 200

Remarks for API request

string

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

)
string

Function call for a function making special actions

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

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

Updated 11 months ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 months ago

Did this page help you?