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

DecisionFlag

integer

Mandatory

Decide if Memo is account level,transaction level or merchant level. Valid Values: '1' is for Account level memo '2' is for Merchant level memo. '3' is for Transaction level memo. '6' is for Card level memo. Example: 1

AccountNumber

string

Conditional

Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXXXX Example:123654789654 Condition: 1. At least one of AdminNumber/AccountNumber is required when 'Decision Flag' tag would be '1'(Account level Memo) 2. Client who support duplicate Account number, they need to provide Merchant number as well.

Allowable Values:

19

AdminNumber

int64

Conditional

Details can be obtain by admin number (Embossing Acct-id) Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 1236547896325874 Condition: 1. At least one of AdminNumber/AccountNumber is required when 'Decision Flag' tag would be '1'(Account level Memo)

MerchantNumber

string

Conditional

Merchant Number which is assigned to a Merchant. Valid Values: 0-9 Example: 205136549 Condition: 'MerchantNumber' is mandatory when 'Decision Flag' value would be '2' (Merchant Level memo)

TransactionID

int64

Conditional

Transaction Number for transaction being posted. Valid Values: 0-9 Example:1236544 Condition: 'TransactionID' is mandatory when 'Decision Flag' value would be '3' (Transaction Level memo).

MemoUniqueID

integer

Optional

A unique ID for the added memo. Valid Values: 0-9 Example:1236544

MemoCreationDateFrom

datetime

Optional

Starting date of Memo search. Used as a criteria to get memo. Format: MM/DD/YYYY Example: 01/01/2020

MemoCreationDateTo

datetime

Optional

End date of Memo search. Used as a criteria to get memo. Format: MM/DD/YYYY Example: 01/01/2020

UserID

string

Optional

User ID of user who created the memo. Valid Values : 0-9,A-Z Example:User123

Allowable Values:

50

MemoReason

string

Optional

Memo Reason. Valid Values: 1=Account level Note,6=Card level Note Example: Account level Note

Allowable Values:

50

BatchSize

integer

Optional

Number of records which can be view in one Batch. Valid Values : 0-9 Example:50 Condition: Default value is 50

PageIndex

integer

Optional

Number of page. Valid Values : 0-9 Example:1 Condition: Default value is 1

TotalRecordCount

integer

Total number of records in an Array. Valid Values: 0-9 Example:150

MemoList

array

Array of Memo list.