Category links

API Links

View Loyalty Disbursements

Action: POST

Endpoint: /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 details
Fields Description

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: 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 details
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

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