Category links

API Links

Reward Summary

The reward summary provides information about the reward points accumulated against various transactions and all redeemed, expired, deleted, and rollback points. The CoreCard system offers ways to retrieve the list of reward rules applied or promotional reward programs available at a card account level.

Get Promotional Reward Details

Action: POST

Endpoint: /api/CoreCredit/Rewards/GetPromotionalRewardDetails

POST /api/CoreCredit/Rewards/GetPromotionalRewardDetails

This API returns the list of promotional rewards plans applied to an account within the provided date range. Each promotional reward plan also includes the details of transactions that were qualified under the promotional plan. Transaction details include transaction date, amount, reward point, reward amount, and others.

Request fields detail
Fields Description

Source

string

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

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

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

AdminNumber

int64

Conditional

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

AccountNumber

string

Conditional

Account Number of Cardholder. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 8000000000000037 Condition:At least one of AdminNumber/AccountNumber is required.

Allowable Values:

19

StartDate

datetime

Optional

It reflect the starting date of promotional plan. Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05

EndDate

datetime

Optional

It reflect the date on which promotional rate ends. Format: MM/DD/YYYY HH:MM:SS Example: 01/02/2020 11:05:05

Sample request body
{
  "Source": "Web",
  "IPAddress": "10.120.0.0",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "AdminNumber": 1478255,
  "AccountNumber": null,
  "StartDate": null,
  "EndDate": null
}
Response fields detail
Fields Description

RuleDetails

array

Array to return promo details basis promotional offer applicable on the Account.

Sample response body

{
  "application/json": {
    "Message": "Success",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": {
      "RuleDetails": [
        {
          "RuleID": 54,
          "RuleName": "5% on Starbucks or Dunkin up to $20_Ignite",
          "OfferPeriod": "03/01/2016-03/31/2016",
          "RewardAmount": 3.47,
          "RewardPoints": 347.0,
          "TransactionInformation": [
            {
              "TransactionID": 1478555555,
              "TransactionPostDate": "03/31/2016 00:00:00",
              "TransmissionDateTime": "03/31/2016 00:00:00",
              "TransactionAmount": 2.6,
              "RewardAmount": 0.13,
              "RewardPoints": 13.0
            }
          ]
        }
      ]
    }
  }
}

Get Reward Summary

Action: POST

Endpoint: /api/CoreCredit/Rewards/GetRewardSummary

POST /api/CoreCredit/Rewards/GetRewardSummary

Use this API to retrieve  summarized details of rewards points that have accumulated, expired, or been forfeited for a card account. The API returns, among other information, the loyalty program name and ID; reward program start and end dates; reward points earned, expired, forfeited, and redeemed; the current reward points balance; and various reward bucket balances. Additionally, the API returns  list of all such loyalty programs applicable on the card account.

Request fields detail
Fields Description

Source

string

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

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

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 Example:8000000000000037 Condition:At least one of AdminNumber/AccountNumber is required.

Allowable Values:

19

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Account id) Valid Values:0-9 Example:82432455 Condition:At least one of AdminNumber/AccountNumber is required.

Sample request body
{
  "Source": "Web",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "AccountNumber": "700000000785214",
  "AdminNumber": 100989
}
Response fields detail
Fields Description

ListRewardsSummary

array

ListRewardsSummary

LoyaltyProgramCount

integer

points detail count.

Sample response body

{
  "application/json": {
    "Message": "Loyalty points processed successfully.",
    "Status": true,
    "ErrorCode": "ERR01022",
    "ResponseData": {
      "ListRewardsSummary": [
        {
          "ListRewardYearWise": [
            {
              "Year": "2020",
              "LoyaltyPointsEarned": 250.0,
              "LoyaltyAmount": 100.0
            }
          ],
          "LoyaltyProgramID": 1,
          "LoyaltyProgramName": "Card Loyalty Program",
          "LoyaltyAmountEarned": 105.0,
          "LoyaltyAmountRedeemed": 20.0,
          "LoyaltyPointsExpired": 10.0,
          "LoyaltyPointsForfeited": 30.0,
          "LoyaltyPointsRecovered": 10.0,
          "LoyaltyPointsAbandoned": 15.0,
          "PendingRedeemPoints": 42.0,
          "ApprovedRedeemPoints": 20.0,
          "BeginningLoyaltyBalance": 100.0,
          "RemainingLoyaltyBalance": 102.0
        }
      ],
      "LoyaltyProgramCount": 1
    }
  }
}