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

Optional

Account number of Card holder. Valid Values: 0-9 Example: 8000000000000037

Allowable Values:

19

DecisionFlag

integer

Optional

Flag value to decide function of API. Valid Values: 0 = Referral Account Rule 1 = Target List Rule 2 = Update Referral Account Rule 3 = Update Target List Rule Example: 1

UniqueID

string

Conditional

A unique value should be sent with every new referral. Valid Values: 0-9, A-Z Example: 987654311234567891 Condition: Required when 'DecisionFlag' would be 0 or 2.

Allowable Values:

64

RuleID

integer

Optional

ID of Loyalty Rule. Valid Values:Corecard will provide the ID. Format:XXXXX Example:12345

Status

integer

Conditional

A rule can be mark as Active or Inactive. Valid Values:0-Active, 1-Inactive Example:0 Condition: 1. In case of Decision Flag 2 and 3 only acceptable value is 1(Inactive). 2. Default and valid value for Decision Flag 0 and 1 is 0 (Active).

StartDate

datetime

Conditional

Date when loyalty rule imposes on the Account. Format:MM/DD/YYYY HH:MM:SS Example:12/11/2020 11:00:00 Condition: This field become mandatory for Decision Flag – 0 and 1 and will be optional for Decision Flag-2 and 3

EndDate

datetime

Conditional

Date when loyalty rule will no longer be active for the Account. Format:MM/DD/YYYY HH:MM:SS Example:12/11/2021 11:00:00 Condition: 1. This field become mandatory for Decision Flag – 0 and 1 and will be optional for Decision Flag-2 and 3 2. In case of update i.e Decision Flag – 2 and 3, EndDate can be updated to Current Date or future date, if EndDate is not crossed.