Developer Documentation

Get all reward transactions for a user

get https://{host}/api_gateway/rewards/core/v1/management/customer//issuals

This API is used to retrieve list of rewards owned by them based on filters.

👍

Note

For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call .

Prerequisites

  • Authentication: Basic or OAuth authentication
  • Default access group

Resource information

URI/api_gateway/rewards/core/v1/management/customer/{customerId}/issuals
HTTP MethodGET
PaginationYes
Batch supportNo
Rate limit informationNone

API endpoint example

https://eu.api.capillarytech.com/api_gateway/rewards/core/v1/management/customer/555567088/issuals?status=true&pointsRefIds=4xyMsS,s74PLp&redemptionType=INTOUCH_REWARD,MILES&ownerType=Journeys&ownerId=123&groupName=group1

Request path parameters

Parameter NameData TypeDescription
customerId*StringUnique identifier of the customer.

Request query parameters

Parameter NameData TypeDescription
PageIntegerAllows to retrieve details of a specific page.
SizeLongResults to show per page. Default - 100.
statusBooleanFilter the reward transactions based on status of the issued reward.
Set status=true to view successful transactions and status=false to view failed transactions.
Successful transactions are the ones where the reward was issued whereas failed transactions are ones where the reward was not issued.
If this parameter is not applied, the response by default gives both successful and failed transactions.
pointsRefIdsStringThe pointsRedemptionRefIds filters data based on Points Redemption Reference IDs which enables the users to trace back points redemption. Multiple pointsRefIds can be passed. The limit is 10. The reward with pointsRedemptionRefIds will only be populated when this filter is passed. You get the pointsRedemptionRefIds when you redeem points using Issue Reward.
Example: pointsRefIds=4xyMsS,s74PLp.
redemptionTypeEnumRetrieves rewards based on their redemption type. Reward redemption is when a customer uses their points/ cash to redeem a reward. 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.
Use comma separated values to retrieve reward details for multiple redemption types. Example: INTOUCH_REWARD, MILES
The values are case sensitive.
This parameter fetches both, failed and successful reward issue transactions. To filter successful transactions for a specific redemption type, set status=true.
ownerTypeEnumModule for which the reward was created. Supported values: Loyalty program, Milestones, Campaigns, Journeys, Goodwill.
ownerIdStringUnique identifier of the owner.
groupNameStringRetrieves rewards associated with a specific group name.
https://eu.api.capillarytech.com/api_gateway/rewards/core/v1/management/customer/555567088/issuals?status=true&pointsRefIds=4xyMsS,s74PLp&redemptionType=INTOUCH_REWARD,MILES&ownerType=Journeys&ownerId=123&groupName=group1

Response parameters

Parameter NameDescription
successIndicates if the operation was successful.
codeThe HTTP status code of the operation.
messageDescriptive message about the operation's outcome.
rewardTransactionIdUnique identifier for the reward transaction.
rewardIssueRefIdReference ID associated with the reward issue.
rewardTransactionDateDate and time of the reward transaction in milliseconds since epoch.
statusNested object containing the status of the reward issue.
successIndicates if the reward was issued successfully.
codeStatus code for the reward issue transaction.
messageStatus message for the reward issue transaction.
rewardDetailsNested object containing details of the issued reward.
rewardIdUnique identifier of the reward.
languageCodeLanguage code of the reward details (e.g., "en" for English).
nameName of the reward.
descriptionDescription of the reward.
termNConditionsIdUnique identifier for the terms and conditions of the reward.
termNConditionsUrlURL to the terms and conditions of the reward.
imageIdUnique identifier for the image associated with the reward.
imageUrlURL to the image associated with the reward.
thumbnailIdUnique identifier for the thumbnail image associated with the reward.
thumbnailUrlURL to the thumbnail image associated with the reward.
enabledIndicates whether the reward is enabled.
ownerTypeType of the owner associated with the reward transaction.
ownerIdIdentifier of the owner associated with the reward transaction.
pointsRedemptionRefIdsA unique identifier generated each time rewards are issued. This field stores a list of these identifiers, allowing you to track multiple points redemption transactions. You have to pass the pointsRefId as a Query param to populate the data of Points Redemption Reference IDs.
fulfillmentStatusDetails about the fulfillment status.
redemptionTypeDetails about the redemption type of the reward.
lastIndicates if the current page is the last.
totalElementsTotal number of elements across all pages.
totalPagesTotal number of pages.
numberOfElementsNumber of elements in the current page.
firstIndicates if the current page is the first.
sizeNumber of elements per page.
numberThe current page number.
{
    "status": {
        "success": true,
        "code": 200,
        "message": "Reward issue transactions fetched successfully"
    },
    "rewardIssueTransactions": [
        {
            "rewardTransactionId": "195894",
            "rewardIssueRefId": "TX2134326",
            "rewardTransactionDate": 1717949928000,
            "status": {
                "success": true,
                "code": 200,
                "message": "Reward issued successfully"
            },
            "rewardDetails": {
                "rewardId": 181458,
                "languageCode": "en",
                "name": "Trail Blazer Sneakers",
                "description": "Rewards for trail running shoes.",
                "termNConditionsId": "cefa7f25-33dc-4885-90d3-0a55ce34a423",
                "termNConditionsUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/782864bf-7b6b-478e-b745-16fbfe1.html",
                "imageId": "ab409284-1da2-4aab-a5d3-84bc3be95b51",
                "imageUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/5e0e57d6-eae1-46ca-83b3-7991abff.jpg",
                "thumbnailId": "ab409284-1da2-4aab-a5d3-84bc3be95b51",
                "thumbnailUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/5e0e57d6-eae1-46ca-83b3-7991abff.jpg",
                "enabled": true,
                "groups": [
                    {
                        "groupName": "Try your luck now",
                        "groupRank": 2
                    }
                ],
                "rewardRank": 3
            },
            "ownerType": "MILESTONE",
            "ownerId": "123",
            "pointsRedemptionRefIds": null,
            "fulfillmentStatus": "DELIVERED",
            "redemptionType": "INTOUCH_REWARD"
        },
        {
            "rewardTransactionId": "195893",
            "rewardIssueRefId": "TX2112619",
            "rewardTransactionDate": 1717949907000,
            "status": {
                "success": true,
                "code": 200,
                "message": "Reward issued successfully"
            },
            "rewardDetails": {
                "rewardId": 180298,
                "languageCode": "en",
                "name": "VIP access to Nike events",
                "description": "VIP access to Nike events",
                "termNConditionsId": "cefa7f25-33dc-4885-90d3-0a55ce34a423",
                "termNConditionsUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/782864bf-7b6b-478e-b745-16fbfe1.html",
                "imageId": "ef92491f-4d82-4b89-b6cc-b3303faf2ea9",
                "imageUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/bd765eb5-f518-4217-923f-4762151f.png",
                "thumbnailId": "ef92491f-4d82-4b89-b6cc-b3303faf2ea9",
                "thumbnailUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/bd765eb5-f518-4217-923f-4762151f.png",
                "enabled": true,
                "groups": [],
                "rewardRank": null
            },
            "ownerType": null,
            "ownerId": "",
            "pointsRedemptionRefIds": null,
            "fulfillmentStatus": "ON ITS WAY",
            "redemptionType": "INTOUCH_REWARD"
        }
    ],
    "pagingDto": {
        "last": true,
        "totalElements": 65,
        "totalPages": 1,
        "numberOfElements": 2,
        "first": true,
        "size": 100,
        "number": 0
    }
}

{
    "status": {
        "success": true,
        "code": 200,
        "message": "Reward issue transactions fetched successfully"
    },
    "rewardIssueTransactions": [
        {
            "rewardTransactionId": "293260",
            "rewardIssueRefId": "transactionNumber",
            "rewardTransactionDate": 1732618023000,
            "status": {
                "success": true,
                "code": 200,
                "message": "Reward issued successfully"
            },
            "rewardDetails": {
                "rewardId": 272383,
                "languageCode": "en",
                "name": "testreward1",
                "description": "testreward1",
                "termNConditionsId": "820a3d7f-2601-405b-9f56-4a3ba8e9df73",
                "termNConditionsUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/06f0da4b-dd0b-48fe-b20d-1cadc76.html",
                "imageId": "bef4d522-2cf8-4fea-8087-376c449d5c85",
                "imageUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/86a1c214-a955-4b40-a2d7-d4dc279.jpeg",
                "thumbnailId": "c886f064-2b3f-4c19-9e86-7f7e5ab5ae04",
                "thumbnailUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/9e0dfad6-5b9d-4e2b-ac15-2870357.jpeg",
                "enabled": true,
                "groups": [],
                "rewardRank": 1
            },
            "ownerType":" LOYALTY_PROGRAM",
            "ownerId": "123",
            "pointsRedemptionRefIds": [
                "4xyMsS"
            ],
            "fulfillmentStatus": null
        }
    ],
    "pagingDto": {
        "last": true,
        "totalElements": 1,
        "totalPages": 1,
        "numberOfElements": 1,
        "first": true,
        "size": 100,
        "number": 0
    }
}

{
    "status": {
        "success": true,
        "code": 200,
        "message": "Reward issue transactions fetched successfully"
    },
    "rewardIssueTransactions": [
        {
            "rewardTransactionId": "293260",
            "rewardIssueRefId": "transactionNumber",
            "rewardTransactionDate": 1732618023000,
            "status": {
                "success": true,
                "code": 200,
                "message": "Reward issued successfully"
            },
            "rewardDetails": {
                "rewardId": 272383,
                "languageCode": "en",
                "name": "testreward1",
                "description": "testreward1",
                "termNConditionsId": "820a3d7f-2601-405b-9f56-4a3ba8e9df73",
                "termNConditionsUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/06f0da4b-dd0b-48fe-b20d-1cadc76.html",
                "imageId": "bef4d522-2cf8-4fea-8087-376c449d5c85",
                "imageUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/86a1c214-a955-4b40-a2d7-d4dc279.jpeg",
                "thumbnailId": "c886f064-2b3f-4c19-9e86-7f7e5ab5ae04",
                "thumbnailUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/9e0dfad6-5b9d-4e2b-ac15-2870357.jpeg",
                "enabled": true,
                "groups": [],
                "rewardRank": 1
            },
            "ownerType": null,
            "ownerId": "",
            "pointsRedemptionRefIds": null,
            "fulfillmentStatus": null,
            "redemptionType": "MILES"
        },
        {
            "rewardTransactionId": "293259",
            "rewardIssueRefId": "transactionNumber",
            "rewardTransactionDate": 1732617999000,
            "status": {
                "success": true,
                "code": 200,
                "message": "Reward issued successfully"
            },
            "rewardDetails": {
                "rewardId": 272383,
                "languageCode": "en",
                "name": "testreward1",
                "description": "testreward1",
                "termNConditionsId": "820a3d7f-2601-405b-9f56-4a3ba8e9df73",
                "termNConditionsUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/06f0da4b-dd0b-48fe-b20d-1cadc76.html",
                "imageId": "bef4d522-2cf8-4fea-8087-376c449d5c85",
                "imageUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/86a1c214-a955-4b40-a2d7-d4dc279.jpeg",
                "thumbnailId": "c886f064-2b3f-4c19-9e86-7f7e5ab5ae04",
                "thumbnailUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/9e0dfad6-5b9d-4e2b-ac15-2870357.jpeg",
                "enabled": true,
                "groups": [],
                "rewardRank": 1
            },
            "ownerType": null,
            "ownerId": "",
            "pointsRedemptionRefIds": null,
            "fulfillmentStatus": null,
            "redemptionType": "MILES"
        },
        {
            "rewardTransactionId": "293175",
            "rewardIssueRefId": "transactionNumber",
            "rewardTransactionDate": 1732605302000,
            "status": {
                "success": true,
                "code": 200,
                "message": "Reward issued successfully"
            },
            "rewardDetails": {
                "rewardId": 272383,
                "languageCode": "en",
                "name": "testreward1",
                "description": "testreward1",
                "termNConditionsId": "820a3d7f-2601-405b-9f56-4a3ba8e9df73",
                "termNConditionsUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/06f0da4b-dd0b-48fe-b20d-1cadc76.html",
                "imageId": "bef4d522-2cf8-4fea-8087-376c449d5c85",
                "imageUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/86a1c214-a955-4b40-a2d7-d4dc279.jpeg",
                "thumbnailId": "c886f064-2b3f-4c19-9e86-7f7e5ab5ae04",
                "thumbnailUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/9e0dfad6-5b9d-4e2b-ac15-2870357.jpeg",
                "enabled": true,
                "groups": [],
                "rewardRank": 1
            },
            "ownerType": null,
            "ownerId": "",
            "pointsRedemptionRefIds": null,
            "fulfillmentStatus": null,
            "redemptionType": "MILES"
        },
        {
            "rewardTransactionId": "286244",
            "rewardIssueRefId": "107",
            "rewardTransactionDate": 1731564661000,
            "status": {
                "success": true,
                "code": 200,
                "message": "Reward issued successfully"
            },
            "rewardDetails": {
                "rewardId": 265893,
                "languageCode": "en",
                "name": "testreward1",
                "description": "testreward1",
                "termNConditionsId": "820a3d7f-2601-405b-9f56-4a3ba8e9df73",
                "termNConditionsUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/06f0da4b-dd0b-48fe-b20d-1cadc76.html",
                "imageId": "bef4d522-2cf8-4fea-8087-376c449d5c85",
                "imageUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/86a1c214-a955-4b40-a2d7-d4dc279.jpeg",
                "thumbnailId": "c886f064-2b3f-4c19-9e86-7f7e5ab5ae04",
                "thumbnailUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/9e0dfad6-5b9d-4e2b-ac15-2870357.jpeg",
                "enabled": true,
                "groups": [],
                "rewardRank": 1
            },
            "ownerType": null,
            "ownerId": "",
            "pointsRedemptionRefIds": null,
            "fulfillmentStatus": null,
            "redemptionType": "INTOUCH_REWARD"
        },
        {
            "rewardTransactionId": "213560",
            "rewardIssueRefId": "107",
            "rewardTransactionDate": 1720702639000,
            "status": {
                "success": true,
                "code": 200,
                "message": "Reward issued successfully"
            },
            "rewardDetails": {
                "rewardId": 198827,
                "languageCode": "en",
                "name": "testreward1",
                "description": "testreward1",
                "termNConditionsId": "820a3d7f-2601-405b-9f56-4a3ba8e9df73",
                "termNConditionsUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/06f0da4b-dd0b-48fe-b20d-1cadc76.html",
                "imageId": "bef4d522-2cf8-4fea-8087-376c449d5c85",
                "imageUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/86a1c214-a955-4b40-a2d7-d4dc279.jpeg",
                "thumbnailId": "c886f064-2b3f-4c19-9e86-7f7e5ab5ae04",
                "thumbnailUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/9e0dfad6-5b9d-4e2b-ac15-2870357.jpeg",
                "enabled": true,
                "groups": [],
                "rewardRank": 1
            },
            "ownerType": null,
            "ownerId": "",
            "pointsRedemptionRefIds": null,
            "fulfillmentStatus": null,
            "redemptionType": "INTOUCH_REWARD"
        }
    ],
    "pagingDto": {
        "last": true,
        "totalElements": 7,
        "totalPages": 1,
        "numberOfElements": 7,
        "first": true,
        "size": 200,
        "number": 0
    }
}

{
    "status": {
        "success": true,
        "code": 200,
        "message": "Reward issue transactions fetched successfully"
    },
    "rewardIssueTransactions": [
        {
            "rewardTransactionId": "289752",
            "rewardIssueRefId": "1732091931",
            "rewardTransactionDate": 1732091931000,
            "status": {
                "success": true,
                "code": 200,
                "message": "Reward issued successfully"
            },
            "rewardDetails": {
                "rewardId": 268608,
                "languageCode": "en",
                "name": "testreward1",
                "description": "testreward1",
                "termNConditionsId": "820a3d7f-2601-405b-9f56-4a3ba8e9df73",
                "termNConditionsUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/06f0da4b-dd0b-48fe-b20d-1cadc76.html",
                "imageId": "bef4d522-2cf8-4fea-8087-376c449d5c85",
                "imageUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/86a1c214-a955-4b40-a2d7-d4dc279.jpeg",
                "thumbnailId": "c886f064-2b3f-4c19-9e86-7f7e5ab5ae04",
                "thumbnailUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/9e0dfad6-5b9d-4e2b-ac15-2870357.jpeg",
                "enabled": true,
                "groups": [
                    {
                        "groupName": "The Home Depot",
                        "groupRank": 1
                    },
                    {
                        "groupName": "Kellanova Rewards",
                        "groupRank": 2
                    }
                ],
                "rewardRank": 1
            },
            "ownerType": null,
            "ownerId": "",
            "pointsRedemptionRefIds": null,
            "fulfillmentStatus": null,
            "redemptionType": null
        }
    ],
    "pagingDto": {
        "last": true,
        "totalElements": 1,
        "totalPages": 1,
        "numberOfElements": 1,
        "first": true,
        "size": 200,
        "number": 0
    }
}
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!