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

InstitutionID

integer

Mandatory

Unique identification number for Institution

MessageCategory

string

Mandatory

The message category for Message Maintenance Valid Values: 0,1,2,3,4 Example: 0-Status, 1-Period, 2-Monetary, 3-Security, 4-Cards

Allowable Values:

20

MessageType

string

Mandatory

Indicates the type of message Valid Values: 0,1 Example: 0- Email, 1-SMS

Allowable Values:

10

TemplateName

string

Mandatory

Name of the Template Valid Values: a-z,0-9

TemplateLanguage

string

Mandatory

Indicates the Language of the Template Valid Values: ‘en’ Example: ‘en’

TemplateStatus

string

Mandatory

Indicates the Status of the Template Valid Values: 1, 2 Example: 1-Active,2-Inactive

Subject

string

Conditional

Indicates the Subject of the Template Valid Values: a-z, 0-9 Condition: Subject is not allowed to enter when Message type selected as SMS

MessageText

string

Mandatory

Indicates the message text of the Template Valid Values: a-z, 0-9

MessageFormat

string

Mandatory

Indicates the type of message format Valid Values: 0,1 Example: 0-Plain Text,1-HTML

TemplateVersion

string

Mandatory

Version of the Template Valid Values: 0-9

DLTTemplateId

string

Optional

Required for SMS Template if going to use "JSON Karix API" SMS Service option Example: a-z, 0-9

ErrorMessage

string

Get or Set ErrorMessage

Info_Code

string

Get or Set Info_Code

TemplateID

string

Get or Set TemplateID