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

Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition:At least one Account identifier input parameter should be passed.

Allowable Values:

19

TransactionID

string

Conditional

Transaction ID of the payment for which the details are being retrieved. Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:23654789 Condition:At least one Account identifier input parameter should be passed.

Allowable Values:

19

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 Condition:At least one Account identifier input parameter should be passed.

CardNumber

string

Conditional

Card Number of account holder. Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896541236 Condition:At least one Account identifier input parameter should be passed.

Allowable Values:

19

AccountID

integer

Conditional

Account ID represents Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Format:XXXXX Example:12345

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

AccountNumber

string

Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404

Allowable Values:

19

HoldPaymentDetails

array

HoldPaymentDetails

TotalPaymentOnHold

decimal

Total or cumulative number of payments on hold. Valid Values:0-9 Format:XX Example:2

TotalAmountOnHold

decimal

Total or cumulative amount of payments on hold. Valid Values:0-9 Format:XXX.XX Example:245.23

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.

Allowable Values:

15