Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Transaction Details by Reward Transaction ID in Connected orgs

This API is used to retrieve details of a specific reward transaction using reward transaction ID, in connected orgs.

get/api_gateway/rewards/core/v1.1/reward-transactions/{rewardTransactionId}

Path parameters

rewardTransactionIdstring required

Unique identifier of the reward transaction. The reward transaction is generated during the issual of the reward.

Headers

DATA-SCOPE-ORGstring

List of Organization IDs

DATA-SCOPEstring

Scopes define what data can be accessed using the API. You can use scopes to control access to data from a parent or child organization. Defining a scope ensures that the response contains only data from the respective organization. Supported headers: SELF, OTHER and ALL.

Response

200

OR
OR
OR
OR

Example response

{
  "status": [
    {
      "success": true,
      "code": 200,
      "message": "Reward issue transactions details fetched successfully"
    }
  ],
  "data": {
    "rewardTransactionId": "32695",
    "orgId": 50672,
    "customerId": 123456,
    "rewardIssueRefId": "transactionNumber",
    "rewardTransactionDate": 1653906525000,
    "status": {
      "success": true,
      "code": 200,
      "message": "Reward issued successfully"
    },
    "quantity": 1,
    "rewardDetails": {
      "rewardId": 663,
      "languageCode": "en",
      "name": " INTOUCH Enabled",
      "description": "Description",
      "imageId": "EXDR12987U",
      "imageUrl": "https://s3.amazonaws.com/crm-nightly-new-solutions/SAHANA_TEST/EXDR12987U?X-Amz-Security-Token=FwoGZXIvYXdzECEaDFH7mzvBmQUc2KqQryLWARZFNas29Qa%2BGT3bozjU69vumkm4K%2FACklgdn2iD2wQJKg3XS5P8SUKcwOriTGT6KXt2f8sq4VQGey7NBKPIfiwEC8YCkOdyt5iHPMt3Cdm1Op4ReXFKvJ2lPyOWEYS1lXYVYHhOHmKwFn%2BlTEIUgQBLna22wNZj4Pug8%2Fs8vBLw3Yf6vYvcrmoQpq0qpM9rPie3i4vMrDZgc03vB5mvlMNqXSwHtpW6X%2BNVX3%2FepQqCaPNj2gsy3%2BTZYK6FBnLyai7%2Fi5ndBqpp9B4Rpkc7%2Fj0T3D5xChAor%2BWMuQYyLRoAD76np90BetlC8Hx42juhaOJ9R1aiZ778N6i7cJhXw35VM6Cezs5uuf4UMQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20241031T073303Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=ASIAXCQYYRKNOA4DTKYN%2F20241031%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5cf28d18d4b666d53f67455e5f54b1af794659c9be90d3e2492701c71a4a8d98",
      "intouchSeriesId": "741888",
      "redemptionType": "INTOUCH_REWARD"
    },
    "pointsRedemption": {
      "status": {
        "success": true,
        "code": 200,
        "message": "Points redeemed successfully."
      }
    }
  }
}