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

DateFrom

datetime

Optional

Start date of rejected transaction search. Valid Values: 0-9 Format: MM/DD/YYYY Example: 02/01/2020

DateTo

datetime

Optional

End date of rejected transaction search. Valid Values: 0-9 Format: MM/DD/YYYY Example: 02/01/2020

MerchantID

integer

Optional

Unique number of merchant account Valid Values:0-9 Format:XXXXX Example:12345

Allowable Values:

20

ProductID

integer

Optional

Product ID Valid Values:0-9 Format:XXXX Example:1234

Allowable Values:

20

TransactionsSourceType

string

Optional

Transactions source like ACH, manual etc. Valid Values: Refer Appendix Section 5.42 (Transaction Source Type). Example:5=IPM, 14= ACH

Allowable Values:

20

BatchStatus

string

Optional

The current status of the batch. Valid values: 5 = Batch Flagged for Deletion 7 = Batch Flagged for Error(s) 12 = Dispute Resolution Batch 9 = Fraud 1 = In-Balance 3 = Needs Re-posting 11 = Non-Monetary Processed 2 = Out-of-Balance 4 = Posted 10 = Processed 8 = Rejected 16 = Rejected: ACH Auto Return 17 = Rejected: ACH Manual Return 6 = Summary

Allowable Values:

20

AccountNumber

string

Optional

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

Allowable Values:

19

BatchID

string

Optional

The identifier of the batch, which is assigned by the system. Valid Values:0-9 Example:1234

Allowable Values:

19

TransactionAmount

decimal

Optional

Amount of Transaction Valid Values:0-9 Format: XXX.XX Example: 200.00

CardAcceptorNameLocation

string

Optional

Name and location details of merchant Valid Values: a-z A-Z Format: XXXXXXXXXXXXXXXX Example: Dental merchant, Nashua

Allowable Values:

20

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

RejectedTransactionList

array

Array of Rejected Transactions list.