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

MerchantNumber

string

Optional

Merchant Number which is assigned to a Merchant. Valid Values:0-9 Format: XXXXXXXXX Example: 205136549

Allowable Values:

50

StoreNumber

string

Optional

Unique Number which is assgined to a Store. Valid Values:0-9 Example: 205136549

Allowable Values:

10

RegisterNumber

string

Optional

Unique Number which is assigned to a register. Valid Values:0-9 Example: 205136549

Allowable Values:

30

FromDate

datetime

Optional

Starting date of transaction search. Used as a criteria for Transaction Filter. Valid Values: 0-9 Format: MM/DD/YYYY Example: 02/01/2020 Condition: Default value should be 1 month before date from current date

ToDate

datetime

Optional

End date of transaction search. Used as a criteria for Transaction Filter Valid Values: 0-9 Format: MM/DD/YYYY Example: 02/01/2020 Condition: Default value should be 1 day before date from current date

TransactionDateTime

datetime

Optional

Date and Time transaction when occurred Valid Values: 0-9 Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 12:10:01

TransactionID

decimal

Optional

Transaction Number for the transaction being posted. Valid Values:0-9 a-z Format:XXXXXXXXXXXXXXXX Example:23654789

PostDateTime

datetime

Optional

This is the time when transaction actually got posted in system. Valid Values: valid date Format:MM/DD/YYYY HH:MM:SS Example: 01/01/2020 12:10:01

AccountNumber

string

Optional

Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one account identifier is required.

Allowable Values:

19

ApplicationNumber

string

Optional

Unique Number generated for the Account creation Application . Valid Values:0-9 Example:8002201421

Allowable Values:

20

FirstName

string

Optional

First name of account holder Valid Values:a-z Format:XXXX Example:John

Allowable Values:

50

LastName

string

Optional

Last name of account holder Valid Values:a-z Format:XXXX Example:Smith

Allowable Values:

50

TransactionType

string

Optional

Type of Transaction (Purchase debit,payment reversal etc) Valid Values: 23 - DIRECTED PAYMENT 3 - INTEREST CREDIT 2 - INTEREST DEBIT 21 - NON-DIRECTED PAYMENT 28 - NON-DIRECTED PAYMENT REVERSAL 22 - PAYMENT REVERSAL 49 - PRINCIPAL CREDIT 48 - PRINCIPAL DEBIT 40 - PURCHASE DEBIT 43 - PURCHASE DEBIT REVERSAL 41 - PURCHASE RETURN 42 - PURCHASE RETURN REVERSAL 29 - REVERSAL OF NON-DIRECTED PAYMENT REVERSAL Format: XX Example: 41

Allowable Values:

25

CreditPlanMaster

integer

Optional

Plan name associated with the card account. Valid Values:A-Z, 0-9 Format:XXXXXX Example:6 Months No Interest if Paid in Full

Amount

decimal

Optional

Amount for which transaction occurred Valid Values: 0-9 Format: $XX.XX Example: $20.00

BatchSize

integer

Optional

Number of Transaction which can be view in one Batch Default Value would be 50. Valid Values:0-9 Format:XX Example:20

PageIndex

integer

Optional

Number of page Default value would be 0 Valid Values:0-9 Format:XX Example:12

TransactionRecords

array

Get or Set TransactionRecords