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

Mandatory

Account number of Card holder/Account Holder. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 7314145404

Allowable Values:

19

TransactionID

decimal

Conditional

Transaction Number for the transaction being posted. Valid Values: 0-9 Example: 23654789

DecisionFlag

integer

Mandatory

Decision Flag for Approving or Declining the Transaction Valid Values: 0 - Approve, 1- Reject Example: 0

AuthorizedSource

integer

Mandatory

Indicator for Authorization source Valid Values: 0 - Email, 1 - SMS, 2 - CSR or 3 - Cancelled by Provider Example: 0

SMSDeliverystatus

integer

Optional

Indicator for SMS Delivery Status Valid Values: 0 - Delivered 1 - Undelivered Example:0 Format: X

SMSDeliveryTimeStamp

datetime

Conditional

Indicator for SMS Delivery date and time Valid Values: 0-9 Format: MM/dd/yyyy HH:mm:ss Example: 01/25/2020 00:00:00 Condition: Mandatory if Delivery Status is Delivered

ResponseDate

datetime

Mandatory

Must indicate the date time of Authorization Response Valid Values: 0-2 Format: MM/dd/yyyy HH:mm:ss Example: 01/25/2020 00:00:00

ProcedureCompletedorScheduled

integer

Mandatory

Determines that the Procedure for which the Purchase Transaction posted is completed/scheduled or not Valid Values: 0- Yes and 1-No Example:0 Format: X

RejectReason

integer

Optional

Reason for Rejection Valid Values: 0 - Did Not Authorize 1 - Services Not Yet Scheduled 2 - Services Scheduled Beyond 30 Days 3 - Wrong Amount 4 - Wrong Plan 5 - Cancelled by Provider 6 - Not Provided 7 - SMS Undelivered Example:1 Format: X

ReferenceID

string

Conditional

This is a unique ID for each sms request that is generated by CC system Valid Values: 0-9, A-Z Condition: This tag must be mandatory only when value of 'AuthorizedSource' tag = 1 i.e., sms Example: 98ATR8547441