This API retrieves the detailed information of a specific issued reward.

👍
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://eucrm.cc.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://eucrm.cc.capillarytech.com/api_gateway/rewards/core/v1/management/customer/383428154/issuals/84630>

Response parameters

Parameter	Data Type	Description
rewardTransactionId	String	Unique identifier for the reward transaction. The reward transaction is generated during the issual of the reward.
rewardIssueRefId	String	Reference identifier for the reward issue
rewardTransactionDate	Long	Timestamp of the reward transaction
quantity	Integer	Quantity of the reward issued
groupRedemption	Boolean	Indicates if the redemption was grouped
rewardId	Integer	Unique identifier for the reward
languageCode	String	Language code for the reward details
name	String	Name of the reward
description	String	Description of the reward
imageId	String	Unique identifier for the reward image
imageUrl	String	URL of the reward image
intouchPoints	Integer	The number of points customers need to burn to purchase the reward.
intouchSeriesId	String	Coupon series ID or cart promotion ID when intouch reward is selected.
redemptionType	String	Type of the redemption process
redeemedPoints	Integer	Number of points redeemed
pointsRedemptionRefId	String	Reference ID for the points redemption
code	String	Code of the voucher
revenueDetails	Object	The list of commission percentage each participant receives.
brandCommission	Decimal	Commission amount for the brand
capillaryCommission	Decimal	Commission amount for Capillary
affiliateCommission	Decimal	Commission amount for affiliates
endCustomerCommission	Decimal	Commission amount for the end customer
paymentMode	String	Mode of payment used in the transaction
cash	Decimal	Amount of cash used in the payment
points	Decimal	Number of points used in the payment
totalAmount	Decimal	Total amount of the transaction
methodOfPayment	String	Method of payment used
methodOfPaymentId	String	Identifier for the method of payment
tenderId	String	Identifier for the tender
amount	Decimal	Amount processed through the tender
customFields	Object	Custom fields with their respective values

{
    "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,
        "promotions": null,
        "customFields": {
            "0a17": "defaultValue",
            "2d8a": "defaultValue",
        },
        "ownerType": null,
        "ownerId": "",
        "groupName": null,
        "groupRank": null,
        "rewardRank": null
    }
}

{
    "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 id and customer

👍
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