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

RequestType

integer

Mandatory

Type of request to be called. Valid Values: 1 = Activation (Account Activation) 2 = Txn Authorization Unverified 3 = Txn Authorization Verified 4 = Verification Failed 5 = Activation Confirmation (Account Activation) Example: 2

ReferenceID

string

Mandatory

This is a unique ID for the sms send service that is generated by CC system. Valid Values: 0-9, A-Z Example: BD44BD79-ABEB-EB11-945D-A4BF010A357E

Allowable Values:

50

SMSResponseText

string

Optional

SMS text received that performs specific action on the account w.r.t. ReferenceID for all and mention Request Types Valid Values: STOP,stop,s,Stop,YES,yes,Y,Yes,NO,no,n.No Example: STOP

Allowable Values:

4

SMSDeliverystatus

integer

Optional

The status of the SMS sent to account holder. Valid Values: 0 = Delivered 1 = Undelivered Example: 1

SMSDeliverytimestamp

datetime

Conditional

Contains date and time of actual account information update. Valid Values: 0-9 Format: MM/DD/YYYY HH:mm:ss Example: 07/10/2021 11:05:05 Condition : SMS Delivery TimeStamp is mandatory if SMS Delivery Status is delivered