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

Conditional

Account number of cardholder. Valid Values: 0-9 Format:XXXXXXXXXXXX Example:123654789632 Condition: At least one of AdminNumber/CardNumber/AccountNumber is required.

Allowable Values:

19

CardNumber

string

Conditional

Card Number of account holder. Valid Values:0-9 Format:XXXXXXXXXXXX Example:1236547896541 Condition: At least one of AdminNumber/CardNumber/AccountNumber is required.

Allowable Values:

19

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid). Valid Values: 0-9 Format:XXXXX Example:12365 Condition: At least one of AdminNumber/CardNumber/AccountNumber is required.

AccountID

integer

Mandatory

BSAccount ID represents Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Valid Values: 0-9 Format:XXXXX Example:782154

RedemptionMethod

string

Optional

Method by which loyalty points will be redeemed for the Account. Valid Values 1 = Manual,2 = Automatic and 3 = As per Loyalty Program Setup

Allowable Values:

5

RedemptionType

string

Optional

Type through which the points will be applied to the Account. Valid Values : 1 = ACH,3 = Statement Credit and 5 = Partner Pay

Allowable Values:

5

RedemptionFrequency

string

Optional

Frequency to indicate when loyalty points will be redeemed for the Account. Valid Value: 4 = Annually on 1st cycle date 5 = Annually on 2nd cycle date 6 = Annually on 3rd cycle date 7 = Annually on 4th cycle date 8 = Annually on 5th cycle date 9 = Annually on 6th cycle date 10 = Annually on 7th cycle date 11 = Annually on 8th cycle date 12 = Annually on 8th cycle date 13 = Annually on 10th cycle date 14 = Annually on 11th cycle date 15 = Annually on 12th cycle date 16 = Monthly Specific Day 17 = Monthly Cycle Day 18 = Quarterly Specific Day 19 = Quarterly Cycle Day

Allowable Values:

5

SpecificDay

string

Conditional

Indicate the day when loyalty points will be redeemed for the Account. Example:12 (12th day) of selected frequency) Condition:This tag is required when Redemption Frequency is set to 'Monthly Specific Day' or 'Quarterly Specific Day'.

Allowable Values:

10

BankAccount

string

Optional

Account Number or Name of the bank through which redemption initiate. Valid Values:0-9 Format:XXXXXXXXXXXX Example:123654214556 Condition : BankAccountNumber can not be left blank if Redemption Type is 1 = ACH.

ResponseID

string

This number indicates that API responded. Response ID is unique. This value will be null if no authentication information was passed. Response ID can be used for tracking

Allowable Values:

15