This API gives all the details for the reward purchased such as Reward ID, Metadata, Intouch points, Programs/tiers, Reward restrictions/limits, and Catalog promotions applied.

👍
Note

For detailed information about our APIs and for hands-on testing. Refer to the documentation in API Overview. Follow the step-by-step guide on making your first API call in Make Your First API Call.

When Dual Eligibility is enabled, a reward can be issued to multiple users registered with the same secondary identifiers, as long as they have unique primary identifiers.

Prerequisites

Authentication: Basic or OAuth authentication
Default access group

Resource information


URI	`/api_gateway/rewards/core/v1/user/reward/brand{BrandName}?userId={userID}`
HTTP Method	GET
Pagination	Yes
Batch support	No
Rate limit information	None

API endpoint example

https:/eu.api.capillarytech.com/api_gateway/rewards/core/v1/user/reward/brand/BUKL?userId=555567088&redemptionType=VENDOR_ONLY_REWARD,MILES&activationStatus=ENABLED&minPoints=750&maxPoints=1000&minCash=100&maxCash=500&status=UPCOMING&sortBy=endDate&createdOnDaysAgo=4

Request path parameters

Parameters	Data Type	Description
Brand Name*	String	Name of the brand. Ex: BUKL

Request query parameters

Parameters	Data Type	Description
userId	Long	Retrieves rewards for a perticular user. Enter the userid customerid. `Example`: `98662653`.
includeExpired	Boolean	Includes details of expired rewards in the response. Pass `includeExpired` as `true`.
page	Integer	To retrieve details of a specific page. Pass 0 not to apply pagination. For example, page=2&size=10 shows 10 results on page 2.
size	Long	Results to show per page.
groupName	List	Retrieves rewards associated with a specific group name. Multiple group names are supported by a comma (","). Example: `groupName`= `groupname1,groupname2`.
label	String	Retrieves rewards linked to a specific label. Provide label ID to retrieve all rewards linked to the label. Example: `3`.
category	List	Retrieves rewards linked to a specific category. Provide the category name to retrieve all rewards linked to that specific category. Example: `fuel`.
redemptionType	List	Retrieves rewards based on their redemption type. Supported values: `GAMES, AUCTION, CART_PROMOTION, CASH_WALLET, VENDOR_ONLY_REWARD, VOUCHER, CASH_BACK, INTOUCH_REWARD, PHYSICAL_REWARD, CHARITY, MILES, GIFT_CARD, SWEEPSTAKES, VENDOR_INTOUCH_REWARD, CARD_DISC`. Multiple redemptionType values can be filtered using comma (,).
activationStatus	String	Retrieves the reward details based on their activation status. Supported Values: `ENABLED`, `DISABLED`, `ALL`. Supported values are case sensitive.
minPoints	Integer	Specifies the minimum points threshold for filtering rewards based on the points used for their purchase. For example: If the minimum points are set to 100, only rewards purchased with points greater than or equal to 100 will be included. This parameter is case-sensitive.
maxPoints	Integer	Specifies the maximum points threshold for filtering rewards based on the points used for their purchase. For example: If the maximum points are set to 100, rewards with points exceeding this value will not be included. This parameter is case-sensitive.
minCash	Integer	Specifies the minimum cash threshold for filtering rewards based on the cash used for their purchase. For example: If the minimum cash is set to 100, rewards purchased using cash below this amount will not be included. This parameter is case-sensitive.
maxCash	Integer	Specifies the maximum cash threshold for filtering rewards based on the cash used for their purchase. For example: If the maximum cash is set to 100, rewards with cash exceeding this amount will not be included. This parameter is case-sensitive.
status	String	Retrieves the reward details based on their status. Supported Values: `LIVE`, `UPCOMING`, `ENDED`. Multiple status can be filtered via a comma (e.g., `LIVE,ENDED`). Supported values are case sensitive.
vendorId	List	Retrieves the rewards associated with a specific vendor, based on the vendor ID. Multiple vendor IDs are supported by a comma (","). Example: `vendor` = `36,32`. There is no specific limit on the number of vendorIds.
createdOnDaysAgo	Integer	Retrieves a list of rewards created before a specific number of days. For example:- If today is January 20 and createdOnDaysAgo=5 is passed, rewards created on or before January 15 will be retrieved, while those created after January 15 will be excluded.
sortBy	String	Sorts the reward based on `points`, `cash`, `startDate` and `endDate`. NOTE: If `sortBy` param is not passed, sorting will happen on reward creation date in DESC order.
orderBy	String	Specifies the order in which results should be sorted. Supported values: "`ASC`" for ascending, "`DESC`" for descending.

https://eu.api.capillarytech.com/api_gateway/rewards/core/v1/user/reward/brand/BUKL?userId=555567088&redemptionType=VENDOR_ONLY_REWARD,MILES&activationStatus=ENABLED&minPoints=750&maxPoints=1000&minCash=100&maxCash=500&status=UPCOMING&sortBy=endDate&createdOnDaysAgo=4

Response parameters

Parameter	Type	Description
success	boolean	Indicates if the request was successful.
code	int	The HTTP status code returned by the server.
message	String	A descriptive message providing additional details about the status of the request.
rewardList	List<RewardDto>	A list containing details about the rewards available for the user, including information.
`rewardList.id`	long	The unique identifier assigned to each reward for reference in the system.
`rewardList.name`	String	The name of the reward, which can be displayed to the user.
`rewardList.description`	String	A short description of the reward, providing more context about its benefits.
`rewardList.imageId`	long	A unique identifier for the image associated with the reward, useful for retrieving image data from a storage system.
`rewardList.imageUrl`	String	The URL link to the full-size image representing the reward, providing visual context for the user.
`rewardList.thumbnailId`	long	A unique identifier for a smaller version of the reward's image, often used as a thumbnail.
`rewardList.thumbnailUrl`	String	The URL to access the thumbnail image of the reward, typically used in lists or previews.
`rewardList.termAndConditionsId`	long	The identifier for the terms and conditions associated with the reward, pointing to a specific document.
`rewardList.termAndConditionsUrl`	String	The URL where users can view the terms and conditions that apply to the reward, ensuring transparency.
`rewardList.tier`	String	The reward tier that indicates the level or category of the reward.
`rewardList.label`	String	A tag or category that helps classify the rewards.
`rewardList.priority`	int	Indicates the priority of the reward. Higher values indicate higher priority for the reward's visibility or redemption.
`rewardList.intouchPoints`	int	The number of points required to redeem the reward.
`rewardList.group`	String	A grouping label or category that this reward may belong to.
`rewardList.startTime`	String	The start date and time when the reward becomes available for redemption by users. Timestamp in the ISO 8601 standard format `YYYY-MM-DDTHH:MM:SS.SSSZ.` (Start time and end time are in UTC time zone)
`rewardList.endTime`	String	The end date and time when the reward will no longer be available for redemption. Timestamp in the ISO 8601 standard format `YYYY-MM-DDTHH:MM:SS.SSSZ`. (Start time and end time are in UTC time zone)
`rewardList.expired`	boolean	A flag indicating whether the reward has expired. `true` means expired, and `false` means the reward is still available.
`rewardList.started`	boolean	Indicates whether the reward has begun and is currently available for redemption.
`rewardList.programId`	long	An identifier for the loyalty program tied to the reward.
`rewardList.categoryList`	List<CategoryDto>	A list of categories associated with the reward.
`rewardList.categoryList.id`	long	Unique identifier of the category.
`rewardList.categoryList.name`	String	Name of category associated with the reward.
`rewardList.categoryList.enabled`	boolean	Specifies if the category is enabled or not.
`rewardList.customFields`	Map<String, String>	A set of custom fields used to store additional metadata about the reward, allowing flexibility in reward configuration.
`rewardList.loyaltyProgramCriteria`	List<CriteriaDto>	A list of criteria or conditions that must be met for the reward to be eligible under a loyalty program.
`rewardList.groups`	List<GroupDto>	A list of groups associated with the reward. This can be used to target specific user groups or demographics.
`rewardList.rewardRestrictions`	RewardConstraintDto	Defines the limitations or conditions that apply to the reward’s use, including validity and redemption conditions.
`rewardList.rewardRestrictions.isValid`	boolean	Indicates whether the reward restrictions are currently valid.
`rewardList.rewardRank`	int	The rank of the reward, which could represent its priority or level within a program.
`rewardList.images`	List<ImageDto>	A list of image details related to the reward.
`rewardList.images.name`	String	Name of the image.
`rewardList.images.altText`	String	Alternative text or description of the image.
`rewardList.images.id`	long	Identifier for internally stored images, generated when uploaded to the file service. Not applicable for external images.
`rewardList.images.url`	String	URL of the image.
`rewardList.images.isExternal`	boolean	Indicates if the image is hosted on an external server.
`rewardList.videos`	List<VideoDto>	A list of video details related to the reward.
`rewardList.videos.name`	String	Name of the video.
`rewardList.videos.altText`	String	Alternative text or description of the video.
`rewardList.videos.id`	long	Identifier for internally stored videos, generated when uploaded to the file service. Not applicable for external videos.
`rewardList.videos.url`	String	URL of the video.
`rewardList.videos.isExternal`	boolean	Indicates if the video is hosted on an external server.
`rewardList.paymentConfigs`	List<PaymentConfigDto>	Configuration details for how users can redeem the reward, including the payment mode and associated ratios or values.
pagingDto	PagingDto	Contains information about the pagination of the results, allowing the user to navigate between multiple pages of rewards.
`pagingDto.last`	boolean	Indicates if the current page is the last page of available results.
`pagingDto.totalElements`	int	The total number of rewards available across all pages, helping to gauge the size of the dataset.
`pagingDto.totalPages`	int	The total number of pages required to display all available rewards.
`pagingDto.numberOfElements`	int	The number of rewards present on the current page, which is a subset of the total rewards.
`pagingDto.first`	boolean	Indicates if the current page is the first page in the paginated result set.
`pagingDto.size`	int	The number of rewards shown per page, used to manage the size of each page in pagination.
`pagingDto.number`	int	The index of the current page, starting from 0 for the first page.
orgLevelRestrictions	OrgLevelRestrictionsDto	Restrictions applied at the organizational level, specifically regarding the redemption type and limits.
`orgLevelRestrictions.isValid`	boolean	Indicates if the organizational restrictions are currently valid and enforceable.
`orgLevelRestrictions.customerRedemptionTypeLevel`	CustomerRedemptionTypeLevelDto	Defines the restrictions for different customer redemption types.
`orgLevelRestrictions.customerRedemptionTypeLevel.rewardConstraintId`	long	The unique identifier for the specific reward constraint being applied.
`orgLevelRestrictions.customerRedemptionTypeLevel.orgId`	long	The organization ID associated with the redemption constraints.
`orgLevelRestrictions.customerRedemptionTypeLevel.kpi`	String	The key performance indicator associated with the redemption type.
`orgLevelRestrictions.customerRedemptionTypeLevel.constraintLevel`	String	Specifies the level at which the constraint is applied.
`orgLevelRestrictions.customerRedemptionTypeLevel.frequencyType`	String	Defines how often the constraint applies, such as monthly, yearly, etc.
`orgLevelRestrictions.customerRedemptionTypeLevel.constraintLimitValue`	double	The maximum value or limit that can be redeemed within the specified frequency.
`orgLevelRestrictions.customerRedemptionTypeLevel.consumed`	double	Tracks how much of the constraint limit has already been consumed.
`orgLevelRestrictions.customerRedemptionTypeLevel.isActive`	boolean	Indicates whether the constraint is currently active and can be enforced.
`orgLevelRestrictions.customerRedemptionTypeLevel.isValid`	boolean	Confirms whether the constraint is valid and enforceable at the time.
cardSeries	List<CardSeriesDto>	List of card series codes associated with the reward.
`cardSeries.id`	long	Unique identifier of the card associated with the reward.
`cardSeries.code`	String	Series code of the card associated with the reward.
labels	List<Long>	List of label IDs associated with the reward.
startDateTime	String	Start date and time of the reward in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
endDateTime	String	End date and time of the reward in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
languageSpecificInfo	array	Contains language-specific details for the reward.
`languageSpecificInfo.richContentRO`	RichContentRO	The rich content object for the reward.
`languageSpecificInfo.richContentRO.content`	String	The HTML-formatted rich text content.
`languageSpecificInfo.richContentRO.isEnabled`	boolean	Indicates whether the rich text content is enabled. Supported Values: `true` or `false`.
`languageSpecificInfo.defaultValue`	String	Default value if rich text content is not mapped to the reward. Required if `isMandatory` is set to `true`.
vendorId	String	Retrieves the rewards associated with a specific vendor.
redemptionType	String	Retrieves rewards based on their redemption type. Possible values: `GAMES, AUCTION, CART_PROMOTION, CASH_WALLET, VENDOR_ONLY_REWARD, VOUCHER, CASH_BACK, INTOUCH_REWARD, PHYSICAL_REWARD, CHARITY, MILES, GIFT_CARD, SWEEPSTAKES, VENDOR_INTOUCH_REWARD, CARD_DISC`. Multiple redemptionType values can be filtered using comma (,).

Error Code	Description
15006	The request is missing the primary identifier.
1014	The provided identifier does not match any existing customer.
404	The specified customer was not found in the organization.

Get rewards for user

👍
Note

Prerequisites

Resource information

API endpoint example

Request path parameters

Request query parameters

Response parameters

👍Note

Prerequisites

Resource information

API endpoint example

Request path parameters

Request query parameters

Response parameters

👍
Note