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

LoyaltyProgramID

integer

Mandatory

ID of Loyalty Program Valid Values:0-9 Format:XXXX Example:2345(Value shared by Corecard).

DecisionFlag

integer

Mandatory

Decide the activity need to perform. 1 = Mapped Rule Id for Loyalty Program 2 = Updated Rule ID Example:1

RuleID

integer

Mandatory

ID of LoyaltyRule. Valid Values: 0-9(Value provided by Corecard) Format: XXXX Example:1234

Priority

integer

Conditional

Decided the priority of loyalty rule. Valid Values: 0-9 Example: 1 Condition: Priority is required if Decisionflag is "1"

Status

integer

Optional

A loyalty rule is considered for the evaluation only when its status is Active at both the places i.e. on Loyalty Rule Setup and on Rule Mapping on Loyalty Program. Valid Values: Active Inactive Example: Active Condition: Default value would be Active

StartDate

datetime

Conditional

A loyalty rule is considered for the evaluation only when its status is Active at both the places i.e. on Loyalty Rule Setup and on Rule Mapping on Loyalty Program.This is a conditional field where if required the user can provide a future date from where the rule in context should start evaluating the loyalty. Valid Values: Format: MM/DD/YYYY HH:MM:SS Example: 01/20/2020 10:11:01 Condition: Start Date is required if DecisionFlag is 1 and Rule Type is Promotional.

EndDate

datetime

Conditional

This is a conditional field where if required the user can provide a future date when the rule in context should end evaluating the loyalty. Valid Values: Format: MM/DD/YYYY HH:MM:SS Example: 01/20/2020 10:11:01 Condition: End Date is required if DecisionFlag is 1 and Rule Type is Promotional.

NextAction

integer

Conditional

Decide if system need to look for other loyalty rule or not. Valid Values: Stop - If the rule suffice the loyalty rule parameter and applied on the transaction then system will stop looking for other loyalty rule. Continue - If the rule suffice the loyalty rule parameter and applied on the transaction then also system look for other rule as well. Example: 2 Condition: Next Action is required if DecisionFlag is 1.