Category links

API Links

Rewards

To incentivize cardholders to use the cards, the Card Issuer provides attractive loyalty points schemes, which change often. The CoreCard system offers flexible set-up of customer reward programs, considering multiple aspects of any incoming transaction. One or multiple reward programs can be configured at the card program level. A single reward program can contain one or multiple transaction evaluation rules. Also, when a transaction is received and evaluated against loyalty rules, then points may be earned against a single rule or multiple rules. Accumulated points are added to the card account's reward points bucket and are made available for redemption or to carry forward. 

Further, the CoreCard System offers reversal of reward points when a transaction reversal or refund is received. In some situations, reward points need to be adjusted manually. Reward points may expire or be forfeited once a defined timeframe for a reward program lapses, and in this case, the reward points are converted into a defined monetary value.

SVG Image

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

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

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

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

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
    }
  }
}

Loyalty Points Management

Action: POST

Endpoint: /api/CoreCredit/Rewards/LoyaltyPointsManagement

POST /api/CoreCredit/Rewards/LoyaltyPointsManagement

Use this API to manually redeem  reward points available on a card account. There are three ways to redeem the rewards points: ACH, statement credit, and partner pay. The API returns  the remaining available reward points after a redemption and the status of the manual redemption.

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

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

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

Card holder's Account Number. 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.

DecisionFlag

string

Mandatory

To decide if Loyatly points needs to Add or Remove Valid Values: 0 = Add Loyalty Points 1 = Reduce Loyalty Points 2 = Redeem Loyalty Points

Allowable Values:

2

LoyaltyProgramID

integer

Mandatory

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

ValueofLoyaltyPoint

decimal

Mandatory

The value of loyalty points to Add/Reduce/Redeem for the Account. Valid Values:0-9 Example:150.50

BankAccountNumber

string

Conditional

This tag reflect the Bank account number of payment bank. Valid Values:0-9 Example:123654214556

Allowable Values:

19

RedemptionMethod

string

Mandatory

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

Allowable Values:

2

LoanPayDown

string

Optional

Flag to decide if Loyalty Points should use for Load Payment or not. Valid Values:0-No and 1-Yes Example : 1

Allowable Values:

2

Notes

string

Optional

The note capture by the user. Valid Values:A-Z,0-9 Example : This is a test note

Allowable Values:

50

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,
  "DecisionFlag": null,
  "LoyaltyProgramID": null,
  "ValueofLoyaltyPoint": null,
  "BankAccountNumber": null,
  "RedemptionMethod": null,
  "LoanPayDown": null,
  "Notes": null
}
Response fields detail
Fields Description

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. Example:7485122

Sample response body

{
  "application/json": {
    "Message": "Loyalty points processed successfully.",
    "Status": true,
    "ErrorCode": "ERR01022",
    "ResponseData": {
      "ResponseID": "154545"
    }
  }
}

Recover Negative Rewards

Action: POST

Endpoint: /api/CoreCredit/Rewards/RecoverNegativeRewards

POST /api/CoreCredit/Rewards/RecoverNegativeRewards

Use this API to recover negative reward balances.

Note

This process is also called as Reward Recovery.

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

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

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 ---- es: means Spanish

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

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:XXXXX Example:12345 Condition:At least one account identifier is required.

AccountNumber

string

Conditional

Account number of cardholder/AccountHolder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one account identifier is required.

Allowable Values:

19

RewardPoints

decimal

Mandatory

Total negative rewards points on the Account which is to be recover from the customer. Valid Values:0-9 Example:200

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

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

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:XXXXX Example:12345 Condition:At least one account identifier is required.

AccountNumber

string

Conditional

Account number of cardholder/AccountHolder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one account identifier is required.

Allowable Values:

19

RewardPoints

decimal

Mandatory

Total negative rewards points on the Account which is to be recover from the customer. Valid Values:0-9 Example:200

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,
  "AdminNumber": null,
  "AccountNumber": "9000000500000097",
  "RewardPoints": 199.2
}
Response fields detail
Fields Description

RewardPoints

decimal

Remaning Rewards points on the Account. Valid Values:0-9 Example:12365478

RewardPoints

decimal

Remaning Rewards points on the Account. Valid Values:0-9 Example:12365478

Sample response body

{
  "application/json": {
    "Message": "Negative Reward Points Offset Generated Successfully",
    "Status": true,
    "ErrorCode": "ERR01143",
    "ResponseData": {
      "RewardPoints": 0.0
    }
  }
}

Rollback Loyalty Points

Action: POST

Endpoint: /api/CoreCredit/Rewards/RollbackLoyaltyPoints

POST /api/CoreCredit/Rewards/RollbackLoyaltyPoints

Use this API to roll back loyalty rewards points accumulated on a particular transaction by providing a loyalty transaction ID.

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

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

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 Format:XXXXXXXXXX Example:7314145404 Condition: At least one account identifier is required.

Allowable Values:

19

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 Condition: At least one account identifier is required.

LoyaltyTransactionID

decimal

Mandatory

Get or Set SKey

CardNumber

string

Optional

Card Number of account holder Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874

Allowable Values:

16

AccountID

integer

Conditional

Account ID represents Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Format:XXXXX Example:12345 Condition:At least one of CardNumber/AdminNumber/AccountNumber/AccountID is required.

UniqueID

decimal

Mandatory

Description: It should be an unique number. Valid Values:0-9 Example:1234567890

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": "1100001000000047",
  "AdminNumber": null,
  "UniqueID": 2.0
}
Response fields detail
Fields Description

Sample response body

{
  "application/json": {
    "Message": "Loyalty points processed successfully.",
    "Status": true,
    "ErrorCode": "ERR01022",
    "ResponseData": null
  }
}

Get Loyalty Program Segment

Action: POST

Endpoint: /api/CoreCredit/Rewards/GetLoyaltyProgramSegment

POST /api/CoreCredit/Rewards/GetLoyaltyProgramSegment

CoreCARD returns a loyalty program summary of reward points across different lifecycle buckets, in terms of credits, debits, adjustments, and redemptions. Use the GetLoyaltyProgramSegment API to retrieve details of reward points earned under a loyalty program with summaries, counts and amount of debits, credits, debit adjustment, credit adjustments, redemptions, and redemptions reversals in differing lifecycle buckets.

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

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

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/AccountHolder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition:At least one of AccountNumber/AdminNumber is required.

Allowable Values:

19

AdminNumber

int64

Conditional

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

LoyaltyProgramID

integer

Optional

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

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": "5000000000011071",
  "AdminNumber": 59934,
  "LoyaltyProgramID": 0
}
Response fields detail
Fields Description

LoyaltyProgramSegment

array

Array to show the details of rewards programwise.

Sample response body

{
  "application/json": {
    "Message": "Success.",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": {
      "LoyaltyProgramSegment": [
        {
          "AccountNumber": "5000000000011071",
          "MaskedCardNumber": "461668XXXXXX4612",
          "LoyaltyProgramName": "Final Loyalty Program",
          "CurrentBalance": 1087.84,
          "FirstUsageBonus": 0.0,
          "DayToDateBucket": {
            "DebitsPoints": 0.0,
            "DebitsCount": 0,
            "CreditsPoints": 0.0,
            "CreditsCount": 1,
            "DebitAdjustmentsPoints": 0.0,
            "DebitAdjustmentsCount": 0,
            "CreditAdjustmentsPoints": 0.0,
            "CreditAdjustmentsCount": 0,
            "RedemptionsPoints": 0.0,
            "RedemptionsCount": 0,
            "RedemptionsReversalsPoints": 0.0,
            "RedemptionsReversalsCount": 0
          },
          "CycleToDateBucket": {
            "DebitsPoints": 60.46,
            "DebitsCount": 1,
            "CreditsPoints": 350.4,
            "CreditsCount": 6,
            "DebitAdjustmentsPoints": 0.0,
            "DebitAdjustmentsCount": 0,
            "CreditAdjustmentsPoints": 0.0,
            "CreditAdjustmentsCount": 0,
            "RedemptionsPoints": 0.0,
            "RedemptionsCount": 0,
            "RedemptionsReversalsPoints": 0.0,
            "RedemptionsReversalsCount": 0
          },
          "MonthToDateBucket": {
            "DebitsPoints": 60.46,
            "DebitsCount": 1,
            "CreditsPoints": 350.4,
            "CreditsCount": 6,
            "DebitAdjustmentsPoints": 0.0,
            "DebitAdjustmentsCount": 0,
            "CreditAdjustmentsPoints": 0.0,
            "CreditAdjustmentsCount": 0,
            "RedemptionsPoints": 0.0,
            "RedemptionsCount": 0,
            "RedemptionsReversalsPoints": 0.0,
            "RedemptionsReversalsCount": 0
          },
          "YearToDateBucket": {
            "DebitsPoints": 60.46,
            "DebitsCount": 1,
            "CreditsPoints": 350.4,
            "CreditsCount": 6,
            "DebitAdjustmentsPoints": 0.0,
            "DebitAdjustmentsCount": 0,
            "CreditAdjustmentsPoints": 350.4,
            "CreditAdjustmentsCount": 0,
            "RedemptionsPoints": 0.0,
            "RedemptionsCount": 0,
            "RedemptionsReversalsPoints": 0.0,
            "RedemptionsReversalsCount": 0
          },
          "LifeToDateBucket": {
            "DebitsPoints": 1219.17,
            "DebitsCount": 3,
            "CreditsPoints": 2307.01,
            "CreditsCount": 16,
            "DebitAdjustmentsPoints": 0.0,
            "DebitAdjustmentsCount": 0,
            "CreditAdjustmentsPoints": 350.4,
            "CreditAdjustmentsCount": 0,
            "RedemptionsPoints": 0.0,
            "RedemptionsCount": 0,
            "RedemptionsReversalsPoints": 0.0,
            "RedemptionsReversalsCount": 0
          }
        }
      ]
    }
  }
}

Get Loyalty Accumulated Points

Action: POST

Endpoint: /api/CoreCredit/Rewards/GetLoyaltyAccumulatePts

POST /api/CoreCredit/Rewards/GetLoyaltyAccumulatePts

Use this API to retrieve the summary of accumulated rewards points. The API fetches the list of applicable loyalty programs on a card account and related reward points information within that program. It shows the loyalty program start and end dates, points earned, the equivalent dollar amounts of the points, expired loyalty points, forfeited loyalty points, and other information.

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

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

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

CardNumber

string

Conditional

This tag reflect the card number Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 1236547896541236 Condition: At least one of Card Number\Admin Number\Account Number\Account id is required.

Allowable Values:

16

AccountNumber

string

Conditional

This tag reflects the account number Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 8000000000000037 Condition: At least one of Card Number\Admin Number\Account Number\Account id is required.

Allowable Values:

19

AdminNumber

int64

Conditional

This Tag reflects the Admin number Valid Values: 0-9 Format: XXXXX Example: 12345 Condition: At least one of Card Number\Admin Number\Account Number\Account id is required.

AccountID

integer

Conditional

Account ID represents Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Format: XXXXX Example: 12345 Condition: At least one of Card Number\Admin Number\Account Number\Account id 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,
  "CardNumber": "",
  "AccountNumber": "0000000000503918",
  "AdminNumber": null,
  "AccountID": 167473
}
Response fields detail
Fields Description

LoyaltyAccumulatePointsList

array

Array of Loyalty Accumulate Points

Sample response body

{
  "application/json": {
    "Message": "Success",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": {
      "LoyaltyAccumulatePointsList": [
        {
          "LoyaltyProgram": 3,
          "LoyaltyProgramName": "Davidson",
          "ProgramStartDate": "04/02/2008 00:00:00",
          "ProgramEndDate": "12/31/2099 00:00:00",
          "LoyaltyPoints": 4420.0,
          "LoyaltyAmount": 44.2,
          "LoyaltyPointsExpired": 0.0,
          "LoyaltyPointsForfeited": 0.0,
          "PromoRewardCTD": 0.0,
          "AmtQualifiedForPromoRewardCTD": 0.0,
          "PendingRedeemPoints": 0.0
        }
      ]
    }
  }
}

Get Transaction Details Loyalty

Action: POST

Endpoint: /api/CoreCredit/Rewards/GetTransactionDetailsLoyalty

POST /api/CoreCredit/Rewards/GetTransactionDetailsLoyalty

The card issuer may utilize the GetTransactionDetailsLoyalty API to retrieve detailed lists of loyalty points against individual transactions posted on a card account. Loyalty transactions may be displayed within a specific period or for a specific statement period. Filter options allow retrieval of transactions based on categories such as earned, used, adjusted, forfeited, expired, reversal, collected, write-off, and abandoned reward points. The API fetches information including the merchant category, transaction date and time, loyalty program rule under which the loyalty points have been earned, type of reward (i.e., base, promotional, advance promotional),and the card acceptor's name and location.

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

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

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.

InstitutionID

integer

Optional

Unique identification number for Institution. Valid Values:0-9 Example:Fixed value needs to pass which is provided by Corecard.

DetailActivityType

string

Optional

Activity Type can be specified for specific transactions . Example : 11 = All,12 = Earned ,13 = Used,14 = Reversal

Allowable Values:

2

MerchantNumber

integer

Optional

Merchant Number.

FromDate

datetime

Optional

Used as a criteria for Transaction Filter. Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05

ToDate

datetime

Optional

Used as a criteria for Transaction Filter. Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05

StatementFrom

datetime

Optional

Used as a criteria for Transaction Filter. Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05

StatementTo

datetime

Optional

Used as a criteria for Transaction Filter. Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05

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,
  "InstitutionID": null,
  "DetailActivityType": "11",
  "MerchantNumber": null,
  "FromDate": null,
  "ToDate": null,
  "StatementFrom": null,
  "StatementTo": null
}
Response fields detail
Fields Description

DetailsCount

integer

Number of Transactions.

TransactionList

array

List of Transactions.

ResponseID

string

This number will ensure that API hit our internal servers.

Allowable Values:

20

AccountUUID

string

Basesegment's Universal Unique Id.

Allowable Values:

20

AdminNumberUUID

string

EmbossingAccount's Universal Unique Id.

Allowable Values:

20

Sample response body

{
  "application/json": {
    "Message": "Loyalty Transaction details returned successfully.",
    "Status": true,
    "ErrorCode": "ERR01023",
    "ResponseData": {
      "DetailsCount": 10,
      "TransactionList": [
        {
          "ReversalTarget": 14554444,
          "PromoPoints": 205.0,
          "LoyaltyExpirationDate": "11/02/2022 00:00:00",
          "TransactionPostTime": "11/02/2020 00:00:00",
          "DetailActivityType": "12",
          "TransactionDescription": "43801 = CASHBACK CREDIT",
          "LoyaltyPoints": 2055.2,
          "EquivalentAmount": 20.02,
          "MerchantName": null,
          "StoreName": null,
          "RegisterName": null,
          "AccountNumber": "8110000000000448",
          "TransactionReference": "123372036855203839",
          "MerchantNameandLocation": null,
          "CardNumberLast4Digit": "4821",
          "TransactionSource": "4",
          "TransactionSourceDescription": "Generated",
          "PostDateTime": "11/02/2020 00:00:00",
          "MerchantCategory": "Restaurants",
          "MCCDescription": "Eating Places, Restaurants",
          "MCCCode": "5812",
          "RedemptionType": null,
          "PromoTxnAmount": 100.02,
          "LoyaltyProgramID": 10,
          "LoyaltyProgramName": "SM Student Loan Rewards Loyalty Program",
          "BasePercent": 1.25,
          "PromoPercent": 1.55,
          "TotalPercent": 1.8,
          "RewardRedeemStatus": null,
          "ClientUniqueId": 3457577,
          "PartnerID": null,
          "ReasonCode": null,
          "RedeemBankAccountName": null,
          "TransactionID": 87874574,
          "RuleName": "Student Loan Base Reward Rule"
        }
      ],
      "ResponseID": "56806584",
      "AccountUUID": "b58ce8d3-2bb1-492a-b224-af548236d843",
      "AdminNumberUUID": "97a5ca01-a0ce-4df1-9050-e5fa00c3b8ab"
    }
  }
}

Update Loyalty Disbursement Parameters

Action: POST

Endpoint: /api/CoreCredit/Rewards/UpdateLoyaltyDisbursementParameters

POST /api/CoreCredit/Rewards/UpdateLoyaltyDisbursementParameters

Use this API to update attributes of existing loyalty disbursement parameters set on a card account using a card number, account number, or admin number. The API allows changing the redemption method, redemption channel, redemption frequency, and other parameters.

Note

Loyalty disbursement parameter attributes can only be changed for an active card account and are eligible for loyalty.

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

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

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 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.

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,
  "AccountNumber": "8110000000000125",
  "CardNumber": null,
  "AdminNumber": 167550,
  "RedemptionMethod": "1",
  "RedemptionType": "1",
  "RedemptionFrequency": "17",
  "SpecificDay": "10",
  "BankAccount": "3052"
}
Response fields detail
Fields Description

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

Sample response body

{
  "application/json": {
    "Message": "Account updated successfully.",
    "Status": true,
    "ErrorCode": "ERR01003",
    "ResponseData": {
      "ResponseID": "47785665"
    }
  }
}

View Loyalty Disbursements

Action: POST

Endpoint: /api/CoreCredit/Rewards/ViewLoyaltyDisbursements

POST /api/CoreCredit/Rewards/ViewLoyaltyDisbursements

Use the ViewLoyaltyDisbursements API to display details of the disbursement method being used for redeeming loyalty points. The API retrieves the details of the redemption method, redemption type, redemption frequency, and bank account information.

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

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

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

Allowable Values:

19

CardNumber

string

Conditional

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

Allowable Values:

16

AdminNumber

int64

Conditional

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

AccountID

integer

Conditional

This tag reflects the Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Valid Values: 0-9 Example: 12345 Condition:At least one of CardNumber/AdminNumber/AccountNumber/AccountID 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": "1000000700010240",
  "CardNumber": null,
  "AdminNumber": null,
  "AccountID": null
}
Response fields detail
Fields Description

RedemptionMethod

string

Method by which loyalty points will be redeemed for the Account. Valid Values: 0-9 Example: 1 - Manual, 2 - Automatic, 3 - As per Loyalty Program Setup

RedemptionType

string

Type through which the points will be applied to the Account. Valid Values: 0-9 Example: 1 - ACH, 3 - Statement Credit, 5 - Partner Pay

RedemptionFrequency

string

Frequency to indicate when loyalty points will be redeemed for the Account. Valid Values: 0-9 Example: 4 - Annually on 1st cycle date

SpecificDay

string

Indicate the day when loyalty points will be redeemed for the Account. Valid Values: 0-9 Example: 1 - 01

BankAccount

string

Account Number or Name of the bank through which redemption initiate. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXXXXX Example: 12345678912345678912

Sample response body

{
  "application/json": {
    "Message": "Loyalty Disbursement Parameters Returned Successfully.",
    "Status": true,
    "ErrorCode": "ERR01072",
    "ResponseData": {
      "RedemptionMethod": "1",
      "RedemptionType": "3",
      "RedemptionFrequency": "17",
      "SpecificDay": null,
      "BankAccount": null
    }
  }
}

Search LP Accounts

Action: POST

Endpoint: /api/CoreCredit/Rewards/SearchLPAccounts

POST /api/CoreCredit/Rewards/SearchLPAccounts

This API is used to SearchLPAccounts.

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

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

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

ProgramID

integer

get or set ProgramId

ProgramParent

string

get or set ProgramParent

InstitutionID

integer

get or set Institution

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,
  "ProgramID": null,
  "ProgramParent": null,
  "InstitutionID": null
}
Response fields detail
Fields Description

SearchRecord

array

get or set SearchRecord

Sample response body

{
  "application/json": {
    "Message": "Success.",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": {
      "SearchRecord": [
        {
          "ProgramID": 22,
          "ProgramName": "UnSecured Loyalty  Program",
          "ProgramParent": null,
          "Institution": "Aven",
          "Priority": 0,
          "ProgramStartDate": "05/26/2017 00:00:00",
          "ProgramEndDate": "10/20/2020 00:00:00",
          "ProgramRedemptionDate": null
        }
      ]
    }
  }
}

GetReferralPromoOfferDetails

Action: POST

Endpoint: /api/CoreCredit/Rewards/GetReferralPromoOfferDetails

POST /api/CoreCredit/Rewards/GetReferralPromoOfferDetails

Purpose of this API is to get the details of each referral for referral promo offer. Details like referral start date, referral end date, referral status etc.

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

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

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

RuleID

integer

Mandatory

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

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": "9110000000000073",
  "AdminNumber": null,
  "RuleID": 1
}
Response fields detail
Fields Description

ReferralPromoDetails

array

Array for promo offer details

Sample response body

{
  "application/json": {
    "Message": "Success",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": {
      "ReferralPromoDetails": [
        {
          "RuleName": "Student Loan Base Reward Rule(Return)",
          "RewardPercent": 5.0,
          "RewardAmountPoints": 10,
          "ReferralStatus": "Active",
          "ReferralStartDateTime": "10/10/2020 00:00:00",
          "ReferralEndDateTime": "10/30/2020 00:00:00"
        }
      ]
    }
  }
}