Get transaction details by id and customer

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

URIapi_gateway/rewards/core/v1/management/customer/{customerId}/issuals/{rewardTransactionId}
HTTP MethodGET
PaginationNo
Batch supportNo
Rate limit informationNone

API endpoint example

https://eucrm.cc.capillarytech.com/api_gateway/rewards/core/v1/management/customer/383428154/issuals/84630

Request path parameters

Parameter NameData TypeDescription
customerid*StringUnique identifier of the reward. Ex: 112295
rewardTransactionId*StringUnique 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

ParameterData TypeDescription
rewardTransactionIdStringUnique identifier for the reward transaction. The reward transaction is generated during the issual of the reward.
rewardIssueRefIdStringReference identifier for the reward issue
rewardTransactionDateLongTimestamp of the reward transaction
quantityIntegerQuantity of the reward issued
groupRedemptionBooleanIndicates if the redemption was grouped
rewardIdIntegerUnique identifier for the reward
languageCodeStringLanguage code for the reward details
nameStringName of the reward
descriptionStringDescription of the reward
imageIdStringUnique identifier for the reward image
imageUrlStringURL of the reward image
intouchPointsIntegerThe number of points customers need to burn to purchase the reward.
intouchSeriesIdStringCoupon series ID or cart promotion ID when intouch reward is selected.
redemptionTypeStringType of the redemption process
redeemedPointsIntegerNumber of points redeemed
pointsRedemptionRefIdStringReference ID for the points redemption
codeStringCode of the voucher
revenueDetailsObjectThe list of commission percentage each participant receives.
brandCommissionDecimalCommission amount for the brand
capillaryCommissionDecimalCommission amount for Capillary
affiliateCommissionDecimalCommission amount for affiliates
endCustomerCommissionDecimalCommission amount for the end customer
paymentModeStringMode of payment used in the transaction
cashDecimalAmount of cash used in the payment
pointsDecimalNumber of points used in the payment
totalAmountDecimalTotal amount of the transaction
methodOfPaymentStringMethod of payment used
methodOfPaymentIdStringIdentifier for the method of payment
tenderIdStringIdentifier for the tender
amountDecimalAmount processed through the tender
customFieldsObjectCustom 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 CodeDescription
6004Reward not found or disabled
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!