This API retrieves the detailed information of a specific issued reward using the 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 or OAuth authentication
Default access group

API Specification


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/383428154/issuals/84630

Request path parameters

Parameter Name	Data Type	Description
customerId*	String	Unique identifier of the reward. Ex: 112295
rewardTransactionId*	String	Unique identifier of the reward transaction. The reward transaction is generated during the issual of the reward.

https://eu.api.capillarytech.com/api_gateway/rewards/core/v1/management/customer/383428154/issuals/84630

Response parameters

Parameter	Description
status	An array containing the status details of the reward issue transaction.
success	Indicates whether the transaction was successful.
code	A unique code representing the status of the transaction.
message	A message providing details about the status of the transaction.
data	Contains detailed information about the reward transaction.
rewardTransactionId	Unique identifier for the reward transaction. The reward transaction is generated during the issual of the reward.
customerId	The ID of the customer associated with the reward transaction.
orgId	The ID of the organization associated with the transaction.
rewardIssueRefId	A reference ID for the reward issuance.
rewardTransactionDate	The timestamp of the reward transaction in milliseconds.
status	Status details of the reward issuance.
success	Indicates whether the reward issuance was successful.
-code	A unique code representing the status of the reward issuance.
-message	A message providing additional information about the status of the reward issuance.
-quantity	The number of rewards issued.
requestedQuantity	This field represents the original quantity that was requested.
groupRedemption	Indicates if the redemption is a group redemption.
rewardDetails	Contains details about the specific reward.
-rewardId	The ID of the reward.
-languageCode	The language code for the reward details.
-name	The name of the reward.
-description	A description of the reward.
-rewardRank	The rank of the reward.
-groups	A list of groups associated with the reward.
-imageId	The ID of the reward image.
-imageUrl	The URL of the reward image.
-intouchPoints	The number of intouch points associated with the reward.
-images	A list of images associated with the reward.
-videos	A list of videos associated with the reward.
pointsRedemption	Details about the points redemption process.
-redeemedPoints	The number of points redeemed.
-pointsRedemptionRefId	A unique identifier generated each time rewards are issued. This field stores identifier, allowing you to track points redemption transaction.
-pointsRedemptionRefIds	A unique identifier generated each time rewards are issued. This field stores a list of these identifiers, allowing you to track multiple points redemption transactions.
status	Status details of the points redemption.
success	Indicates whether the points redemption was successful.
code	A unique code representing the status of the points redemption.
message	A message providing additional information about the points redemption status.
redemptionDetails	An array of objects specifying the details about the redemption process.
-redemptionType	Specifies the category of reward redemption available. It indicates how users can redeem the reward.
-totalRedemptionValue	The total value of the redemption.
vouchers	A list of vouchers associated with the redemption.
vendorRewards	Contains vendor-specific reward details.
rewards	A list of rewards issued by the vendor.
customFields	Custom fields for additional information.
transactionCustomFields	Custom fields associated with the transaction.
ownerId	The ID of the owner associated with the reward transaction.
eventLogId	A plain string identifier used to identify the transaction associated with a reward issual.

{
    "status": [
        {
            "success": true,
            "code": 200,
            "message": "Reward issue transactions details fetched successfully"
        }
    ],
    "data": {
        "rewardTransactionId": "293260",
        "customerId": 555567088,
        "orgId": 100458,
        "rewardIssueRefId": "transactionNumber",
        "rewardTransactionDate": 1732618023000,
        "status": {
            "success": true,
            "code": 200,
            "message": "Reward issued successfully"
        },
        "quantity": 1,
        "requestedQuantity": 1,
        "groupRedemption": false,
        "rewardDetails": {
            "rewardId": 272383,
            "languageCode": "en",
            "name": "testreward1",
            "description": "testreward1",
            "rewardRank": 1,
            "groups": [],
            "imageId": "bef4d522-2cf8-4fea-8087-376c449d5c85",
            "imageUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/86a1c214-a955-4b40-a2d7-d4dc279.jpeg",
            "intouchPoints": 500,
            "redemptionType": "MILES",
            "images": [],
            "videos": []
        },
        "pointsRedemption": {
            "redeemedPoints": 3,
            "pointsRedemptionRefId": "4xyMsS",
            "pointsRedemptionRefIds": [
                "4xyMsS"
            ],
            "status": {
                "success": true,
                "code": 200,
                "message": "Points redeemed successfully."
            }
        },
        "redemptionDetails": {
            "redemptionType": "MILES",
            "totalRedemptionValue": 1.0000
        },
        "vouchers": [],
        "vendorRewards": {
            "rewards": [
                {
                    "json": "{}"
                }
            ]
        },
        "customFields": {
            "CF1": "Custom field 1"
        },
        "transactionCustomFields": {
            "testdate": "2020-01-01 01:01:01"
        },
        "ownerId": "",
        "eventLogId": "abc"
    }
}

{
    "status": [
        {
            "success": true,
            "code": 200,
            "message": "Reward issue transactions details fetched successfully"
        }
    ],
    "data": {
        "rewardTransactionId": "17337",
        "rewardIssueRefId": "transactionNumber",
        "rewardTransactionDate": 1709715033000,
        "status": {
            "success": true,
            "code": 200,
            "message": "Reward issued successfully"
        },
        "quantity": 1,
        "groupRedemption": false,
        "rewardDetails": {
            "rewardId": 6834,
            "languageCode": "en",
            "name": " INTOUCH Enabled",
            "description": "Description",
            "imageId": "EXDR12987U",
            "imageUrl": "https://s3.us-west-2.amazonaws.com/devenv-crm-solutionsvannnld9gg/marvel_automation/EXDR12987U?X-Amz-Security-Token=FwoGZXIvYXdzELr%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDDP8T9uN3cAstrAKoyLcAcNt9HvLcn79YTO%2F0glMCtFy1d6wnZiNGBvp%2Ff3vSltITx7OfgQsbqGtn7DKigqaWAjvnbVWNuNqnDzjzpX1FrSi1rLMnsgCZft3iFKTm3hlhzWlzLz5vR8cFQT6zfSHBy21%2FmxihnYpezB4Lv3qmy%2B84YWo1m95XPHCzvI3Sm%2B2PjtDgHhUchz3u1kL1v%2Bet2ZXsrh2Ohr4L3D5gisp35DVA4DzbWaaciOyJaA2cn37atfcuoQp4zgmBLQ8d%2FfssP5DAhzjZaoQwWBuBNirWKNA%2FQvEG0cThifoIXwonNqgrwYyLY1rvytALzqJdLGfupaZmTIK3kBoOniOjE94ywZBz1MNF7LeEWLHWb%2BLJ18ziw%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240306T085348Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAXCQYYRKNPPABXCPZ%2F20240306%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=60b44f05b120b061bfaeca7233d610c8221daafdaa6fc9d134b3920afb1d95f3",
            "intouchPoints": 1,
            "intouchSeriesId": "1135336",
            "redemptionType": "INTOUCH_REWARD",
            "vendorName": null,
            "vendorId": null,
            "vendorRedemptionId": null,
            "vendorRedemptionName": null,
            "images": [],
            "videos": []
        },
        "pointsRedemption": {
            "redeemedPoints": 1,
            "vendorName": "Points vendor_1",
            "referenceId": null,
            "pointsRedemptionRefId": "0rjghc",
            "status": {
                "success": true,
                "code": 200,
                "message": "Points redeemed successfully."
            },
            "stageReferenceId": null,
            "vendorId": null,
            "requestBody": null,
            "responseBody": null,
            "headers": null
        },
        "pointsRedemptionCheck": null,
        "issueReward": null,
        "revokeReward": null,
        "constraintsCheck": null,
        "catalogPromotions": null,
        "appliedPromotions": null,
        "vouchers": [
            {
                "code": "XS35QH1HA1OFHP269NZ0H0UCIZSY7S22F2DMP",
                "revenueDetails": {
                    "brandCommission": 1.00,
                    "capillaryCommission": 0.00,
                    "affiliateCommission": 1.20,
                    "endCustomerCommission": 1.30
                }
            }
        ],
        "promotions": null,
        "customFields": {
            "0a17": "defaultValue",
            "2d8a": "defaultValue",
        },
        "ownerType": null,
        "ownerId": "",
        "groupName": null,
        "groupRank": null,
        "rewardRank": null
    }
}

API-specific error codes

Error Code	Description
6004	Reward not found or disabled

Get transaction details by Customer ID and Reward Transaction ID

👍
Note

Prerequisites

API Specification

API endpoint example

Request path parameters

Response parameters

API-specific error codes

👍Note

Prerequisites

API Specification

API endpoint example

Request path parameters

Response parameters

API-specific error codes

👍
Note