get https://{host}/api_gateway/rewards/core/v1/management/customer//issuals/
This API allows you to retrieve reward transaction of a customer using customer ID and reward transaction ID.
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 authentication
- Default access group
Resource information
| URI | api_gateway/rewards/core/v1/management/customer/{customerId}/issuals/{rewardTransactionid} |
| HTTP Method | GET |
| Pagination | No |
| Batch support | No |
| Rate limit information | None |
API endpoint example
https://eu.api.capillarytech.com/api_gateway/rewards/core/v1/management/customer/556875097/issuals/195894
Request path parameters
| Parameter | Data type | Description |
|---|---|---|
| customerId* | Integer | Unique ID of the customer. |
| rewardTransactionId* | Integer | Unique ID of the reward transaction. You can get this after issuing the reward. |
Response parameters
| Parameter | Description |
|---|---|
| success | Indicates whether the specific API call was successful. |
| code | The status code related to the specific part of the transaction. |
| message | A descriptive message regarding the status of the transaction. |
| rewardTransactionId | Unique identifier for the reward transaction. |
| rewardIssueRefId | Reference identifier for the reward issue transaction. |
| rewardTransactionDate | Timestamp indicating when the transaction took place. |
| success | Indicates the success of the reward transaction specifically. |
| code | Status code associated with the reward transaction. |
| message | Description of the reward transaction status. |
| rewardId | Unique identifier of the reward. |
| languageCode | Language code for the reward details. |
| name | The name of the reward. |
| description | Description of the reward. |
| termNConditionsId | ID for the terms and conditions associated with the reward |
| termNConditionsUrl | URL to the terms and conditions document |
| imageId | Identifier for the reward's image. |
| imageUrl | URL of the reward's image. |
| enabled | Boolean flag to indicate if the reward is enabled or not. |
| success | Indicates if the points redemption was successful. |
| code | Status code related to the points redemption. |
| message | Description of the points redemption status. |
| ownerType | The module claimed by the badge. Supported values: Loyalty program, Milestones, Campaigns, Journeys, Goodwill. |
| ownerId | Identifier of the owner of the transaction, here shown as an empty string. |
| intouchPoints | Number of InTouch points associated with the reward. |
| intouchSeriesId | InTouch series ID |
| redemptionType | Type of redemption for the reward. |
| vendorName | Name of the vendor |
| vendorId | Unique identifier for the vendor |
| vendorRedemptionId | Vendor redemption ID |
| vendorRedemptionName | Name of the vendor redemption. |
| images | Array of images associated with the reward. |
| pointsRedemption | Object containing details of the points redemption. |
| issueReward | Issue reward details |
| revokeReward | Revoke reward details |
| vouchers | Array of vouchers associated with the reward. |
| ownerType | Type of the owner |
| ownerId | Tender details |
{
"status": [
{
"success": true,
"code": 200,
"message": "Reward issue transactions details fetched successfully"
}
],
"data": {
"rewardTransactionId": "195894",
"rewardIssueRefId": "TX2134326",
"rewardTransactionDate": 1717949928000,
"status": {
"success": true,
"code": 200,
"message": "Reward issued successfully"
},
"quantity": 1,
"requestedQuantity": 0,
"groupRedemption": false,
"rewardDetails": {
"rewardId": 181458,
"languageCode": "en",
"name": "Trail Blazer Sneakers",
"description": "Rewards for trail running shoes.",
"rewardRank": 3,
"groups": [],
"intouchPoints": 0,
"intouchSeriesId": "542218",
"redemptionType": "INTOUCH_REWARD",
"images": [],
"videos": []
},
"pointsRedemption": {
"redeemedPoints": 300,
"pointsRedemptionRefId": "OPDPdf",
"pointsRedemptionRefIds": [
"OPDPdf"
],
"status": {
"success": true,
"code": 200,
"message": "Points redeemed successfully."
}
},
"vouchers": [
{
"code": "NIKERWD306",
"codeExpiry": "2024-07-31 00:00:00",
"revenueDetails": {
"brandCommission": 0.00,
"capillaryCommission": 0.00,
"affiliateCommission": 0.00,
"endCustomerCommission": 0.00
},
"paymentDetails": {
"paymentMode": "POINTS",
"id": 189,
"points": 300.0000
},
"redemptionDetails": {
"redemptionType": "INTOUCH_REWARD",
"redemptionValue": null
}
}
],
"vendorRewards": {
"rewards": []
},
"customFields": {
"testdate": "2020-01-01 01:01:01"
},
"fulfillmentDetails": {
"createdOn": 1717949928000,
"status": "Order confirmed"
},
"fulfillmentDetailsAuditLog": [
{
"createdOn": 1717949928000,
"status": "Order confirmed"
}
],
"ownerId": ""
}
}
API-specific error codes
| Error code | Description |
|---|---|
| 404 | Resource not found |