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

AccountNumber

string

Conditional

Card Holder's Account Number. Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874 Condition:At least one of AccountNumber/AccountID is required.

Allowable Values:

19

AdminNumber

int64

Optional

Admin Number. Valid Values:0-9 Example:7485122

AccountID

integer

Conditional

Account ID represents Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Valid Values:0-9 Example:7485122 Condition:At least one of AccountNumber/AccountID is required.

FromDate

datetime

Optional

Starting date of Transaction search. Valid Values:01/15/2020 Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

ToDate

datetime

Optional

End date of Transaction search. Valid Values:01/15/2020 Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

TransactionType

string

Optional

Type of Transaction. Valid Values:0 = All,1 = ATM,3 = Fees,4 = Purchase,7 = Transfers,8 = Disputed,9 = Payments,10 = Payment Example:Fees/Purchase/ATM.

Allowable Values:

2

TransactionID

int64

Optional

Transaction ID of a Transaction. Example:8574152.

TransactionHistoryType

integer

Mandatory

Type of Transaction's History. Valid Values:1,2,3,4,5 Example:0=All,1 = Settled, 2 = OutStanding , 3 = Expired, 4 = Warehoused , 5 = Unbilled

Merchant

string

Optional

Name of the Merchant. Valid Values:a-z,0-9 Example:Wallmart

Allowable Values:

50

MinTransactionAmount

decimal

Optional

Minimum Transaction Amount on the Account. Valid Values:0-9 Example:200.00

MaxTransactionAmount

decimal

Optional

Maximum Transaction Amount on the Account. Valid Values:0-9 Example:200.00

BatchSize

integer

Optional

Number of Transaction which can be view in one Batch. BatchSize can have value 1-100,On the basis of PageIndex and BatchSize paging will be done. BatchSize can not exceed 100. Default Batch Size should be 100. Valid Values:0-100 Example:10,50.

PageIndex

integer

Optional

Number of page. PageIndex can not exceed 999. Valid Values:0-999 Example:1.

IdentifierToken

string

Conditional

A generated token that is not expired can be used as an input field to access API. If we are passing this field in input, user should not pass any other account identifier. Condition:At least one account identifier is required.

Allowable Values:

800

AMEXTID

string

Optional

A unique number given by the Network to identify a Cardmember Transaction throughout its life cycle. Valid Values: 0-9 Format: 999999999999999

Allowable Values:

15

TransactionLifeCycleUniqueID

string

Optional

Lifecycle Transaction ID of a Transaction.This is the unique id for all types of transactions including dispute, clearing, reversal etc. Valid Values: 0 - 9,a-z Format: 0000xxxx

Allowable Values:

25

CurrentAdminNumber

integer

Optional

CurrentAdminNumber Valid Values: 0 - 9,a-z Format: 0000xxxx

TotalRecordCount

integer

Total No of records.

TransactionHistoryList

array

Transaction History List.