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: 8000000000000037

Allowable Values:

19

CardNumber

string

Conditional

Card Number of account holder. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 1236547896325874

Allowable Values:

19

AdminNumber

int64

Conditional

Admin number. Valid Values: 0-9 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

AlertStatus

string

It shows current Alert status for particular user account. 1 - Active Alert and 2 - Stop Alert.

Allowable Values:

2

PeriodAlertsCount

integer

Total Period Self Service Group returned count

MonetaryAlertsCount

integer

Total Monetary Self Service Group returned count

SecurityAlertsCount

integer

Total Security Self Service Group returned count

CardAlertsCount

integer

Total Cards Self Service Group returned count

StatusAlertsCount

integer

Total Status Self Service Group returned count

MobileNumber

string

Mobile Phone Number in which SMS Alert need to be send

Allowable Values:

10

MobileCarrier

string

Carrier of Mobile Phone number

Allowable Values:

30

MarketingSource

string

Marketing Source

Allowable Values:

1

AlertDate

datetime

Date in which alert setup process being invoke

EmailID

string

Email Id in which Email Alerts need to be send

Allowable Values:

300

AlertList

array

Account Alerts List