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

UpdateFlag

integer

Optional

Indicates whether request is an insert request or update request 1: for Update request 0: for Insert request

InstitutionId

integer

Optional

Unique identification number for Institution. Valid Values:0-9 Format:XXXX Example:Fixed value needs to pass which is provided by Corecard.

MRTID

string

Conditional

Merchant rate table ID is mendatory when request is an update request Valid Values:0-9,A-Z Format: XXX Example: 561 Condition: Mandatory when its an update request

Allowable Values:

19

MerchantRateTable

string

Conditional

This tag refers to the Rate table of that plan. Valid Values:A-Z, 0-9 Format:XXXXXX Example:6 Months No Interest if Paid in Full

Allowable Values:

20

MerchantRateParentName

string

Optional

It is used to provide Parent to inherit Merchant Rate Table Valid Values:0-9, A-Z Format: XXXX Example: MRT1

Allowable Values:

20

FeeType

integer

Conditional

Type of Fee included - 0: Discount 1: Participation Valid Values:0,1 Format:X Example:0,1

DiscountFeeTiming

integer

Optional

Frequency of Discount Fee- 0: Daily 1: Weekly 2: Cycle 3: Per Transaction Valid Values:0,1,2,3 Format: X Example: 0,1,2,3

FeeCalculationBasis

integer

Optional

On what basis the fee will calculated as - 0: Count 1: Amount 2: Both Valid Values:0,1,2 Format: X Example: 0,1,2

VolumeType

integer

Optional

Volume Type 0: Daily 1: Weekly Valid Values:0,1 Format: X Example: 0,1

FeeCalculation

string

Conditional

Fee Calculation 0: Percent of volume amount Valid Values:0 Format: X Example: 0

Allowable Values:

20

AmountPerVolume

decimal

Optional

Amount Per Volume Valid Values:0-9 Format: XX.XX Example: 245.22

AmountPerTransaction

decimal

Optional

Amount per transaction. Valid Values:0-9 Format: XX.XX Example: 245.22

TransactionCode

string

Optional

Transaction Code for the posting of Single Transaction. Valid Values: 427248 = Principal Adjustment

Allowable Values:

20

MRTDetailList

array

Optional

MRTDetailList

ResponseID

string

This number indicates that API responded.Response ID is unique.This value will be null if no authentication information was passed. Response ID can be used for tracking