Category links

API Links

Get Interest Charge

Action: POST

Endpoint: /api/CoreCredit/ControlParameters/GetInterestCharge

Use this API to obtain the interest charges defined for a merchant for different interest plans by using the interest plan ID and merchant ID. The API returns other available details such as interest set on a fixed rate and the index rate for a variable rate.

Request fields details
Fields Description

Source

string

Mandatory

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

Mandatory

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Mandatory

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

MerchantID

integer

Mandatory

Specific ID Assigned to a Merchant, Mandatory If Merchant Number not Inputted in API Request. Valid Values: 0-9 Format: XXXX Example: 562489

InterestPlanID

integer

Mandatory

Interest Plan Id defined on Intreset Tables . Valid Values:0-9, A-z Format:XX Example:abc_IP_22.99

InterestPlanParent

integer

Optional

Parent Name of Interest Plan Valid Values:0-9, A-z Format:XX Example:1234

InterestTransactionCode

string

Optional

Transaction Code for Interest Valid Values:0-9, A-z Format:XX Example:2000-Intreset Charge

Allowable Values:

20

MonetaryTransactionControlGroup

integer

Optional

Group defined on a product for its monetary transaction like defining Fees, Interest, Transactioncodes etc. Valid Values:0-9 Format:XX Example:abc_MTCG

PrimaryCurrencyCode

string

Optional

Code for PrimaryCurrency. Valid Values: XXX Format: 0-9 Example: 1234

Allowable Values:

3

ProductType

string

Optional

It provides a description of the type of card being processed Valid Values:0-9, a-z Format:XXXXX Example:BankCard

Allowable Values:

5

Sample request body
{
  "Source": "Web",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "MerchantID": 7031,
  "InterestPlanID": 1231,
  "InterestPlanParent": null,
  "InterestTransactionCode": null,
  "MonetaryTransactionControlGroup": null,
  "PrimaryCurrencyCode": null,
  "ProductType": null
}
Response fields details
Fields Description

InterestChargeDetails

list of Interest Charges defined on a Merchant.

Sample response body

{
  "Message": "Success.",
  "Status": true,
  "ErrorCode": "Err00017",
  "ResponseData": {
    "InterestChargeDetails": {
      "PrimaryCurrencyCode": "US Dollar",
      "InterestPlanParent": "Template Record",
      "MonetaryTransactionControlGroup": "abc MTC",
      "InterestTransactionCode": "6614 = INTEREST CHARGES",
      "MerchantName": "7031",
      "ProductType": "Bankcard",
      "InterestonAnnualFees": 1,
      "InterestonInsufficientFundsFees": 1,
      "InterestonInterest": 1,
      "InterestonTransactionFees": 1,
      "InterestonOverlimitFees": 1,
      "InterestonInsurance": 1,
      "InterestonCollectionFees": 1,
      "InterestonRecoveryFees": 1,
      "InterestonLateFees": 1,
      "InterestStartDebit": 1,
      "InterestStartCredit": 0,
      "InterestNextStatement": 2,
      "InterestNextStatementMethod": 5,
      "YearBase": 0,
      "AccuralMethod": 2,
      "InterestCalculationRounding": 0,
      "DeliquencyLevel": 0,
      "InterestRateType": 1,
      "MinimumInterestRate": 0.0,
      "MaximumInterestRate": 0.0,
      "MaximumRateDecrease": 0.0,
      "MaximumRateIncrease": 0.0,
      "FixedRate1": 17.9,
      "FixedRate2": 0.0,
      "FixedRate3": 0.0,
      "FixedRate4": 0.0,
      "TierLimitIndicatorFixedRate": 0,
      "Tiermaximumbalance1FixedRate": 0.0,
      "Tiermaximumbalance2FixedRate": 0.0,
      "Tiermaximumbalance3FixedRate": 0.0,
      "IndexRateParent": 2000,
      "MarginRateParent": 2000,
      "MarginRateParent2": null,
      "MarginRateParent3": null,
      "MarginRateParent4": null,
      "IndexRate": 3.5,
      "MarginRate": 14.5,
      "MarginRate2": 0.0,
      "MarginRate3": 0.0,
      "MarginRate4": 0.0,
      "TierLimitIndicatorVariableRate": 0,
      "Tiermaximumbalance1VariableRate": 0.0,
      "Tiermaximumbalance2VariableRate": 0.0,
      "Tiermaximumbalance3VariableRate": 0.0
    }
  }
}