Time	Status	User Agent
Retrieving recent requests…

This API is used to retrieve Vendor Redemption details. You can specify either a particular vendor or a reward type to filter the redemption details

👍
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 .

Example request

curl --location 'https://eu.api.capillarytech.com/api_gateway/rewards/core/v1/vendor/redemptions?page=0&size=10&vendorId=430&order=ASC&redemptionType=INTOUCH_REWARD&sortOn=LAST_UPDATED_ON' \
--header 'Authorization: Basic bWFkaHVfMjU2YQ==' \
--header 'Cookie: _cfuvid=8rpNyzE0Ay41U4JARZee6dsWf__nZ.F84E_l3QkuwKU-1734505895564-0.0.1.1-604800000; _cfuvid=NtRONY0QwuYX36Yw4pjmIyA9l2D5m4QjzK0D0oQyNxA-1764223014942-0.0.1.1-604800000' \
--header 'Accept: application/json'

curl --location 'https://eu.api.capillarytech.com/api_gateway/rewards/core/v1/vendor/redemptions?order=DESC&redemptionType=INTOUCH_REWARD&sortOn=LAST_UPDATED_ON' \
--header 'Authorization: Basic bWFkaHzI3MjU2YQ==' \
--header 'Cookie: _cfuvid=8rpNyzE0Ay41U4JARZee6dsWf__nZ.F84E_l3QkuwKU-1734505895564-0.0.1.1-604800000; _cfuvid=UN7LBPD0Ze6HcR1IkmVQYBfFVNI5f8Y.u5QwTnxv8Uo-1764223624323-0.0.1.1-604800000' \
--header 'Accept: application/json'

Prerequisites

Authentication: Basic or OAuth authentication
Default access group

API Specification


URI	/api_gateway/rewards/core/v1/vendor/redemptions
HTTP Method	GET
Pagination	Yes
Batch support	No
Rate limit information	None

Request query parameters

Parameter Name	Data Type	Description
size	Integer	Size of the page. The default value is 50.
page	Integer	Specifies the page number for which results are retrieved. The default value is `0`, which returns the first page; 1 returns the next page, and subsequent values return subsequent pages.
vendorId	Integer	A unique identifier for the vendor associated with the reward.
redemptionType	Enum	Specifies the category of reward redemption available, it indicates how users can redeem the reward. Supported values: `GAMES, AUCTION, CART_PROMOTION, CASH_WALLET, VENDOR_ONLY_REWARD, VOUCHER, CASH_BACK, INTOUCH_REWARD, PHYSICAL_REWARD, CHARITY, MILES, GIFT_CARD, SWEEPSTAKES, VENDOR_INTOUCH_REWARD, CARD_DISC`.
sortOn	Enum	Sorts the returned vendor list. Supported values : `lastUpdatedOn`
order	Enum	Specifies the order in which results should be sorted based on `lastUpdatedOn` parameter . Supported values: `"ASC"` for ascending, `"DESC"` for descending. Default value is `"DESC"`

Example response

{
    "status": {
        "success": true,
        "code": 5011,
        "message": "Vendor redemption fetched successfully"
    },
    "redemptionList": [
        {
            "id": 34421,
            "name": "UAT Vendor Redemption 1",
            "enabled": true,
            "responseKeys": [
                "voucher"
            ],
            "lastUpdatedOn": 1759733970000,
            "lastUpdatedOnDateTime": "2025-10-06T06:59:30Z",
            "redemptionType": "INTOUCH_REWARD",
            "vendorId": 430,
            "vendorName": "UAT Vendor 8",
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759733970000,
            "createdOnDateTime": "2025-10-06T06:59:30Z",
            "redemptionActionList": [
                {
                    "id": 25858,
                    "name": "add good will points",
                    "enabled": true,
                    "apiType": "POST",
                    "apiUrl": "https://crm-nightly-new.cc.capillarytech.com/v1.1/request/add?program_id=2851",
                    "apiHeaders": {
                        "Authorization": "Basic bHVjaWF1dG9fdGlsbF8xMDoyMDJjYjk2MmFjNTkwNzViOTY0YjA3MTUyZDIzNGI3MA==",
                        "accept": "application/json",
                        "Content-Type": "application/json"
                    },
                    "apiBody": "{\"customFields_property\": {\"customField_1_property\": \"${customfield_CF1}\"}, \"transactionId_property\": \"${rewardTransactionId}\", \"fulfillmentStatus_property\": \"${fulfillmentStatus}\"}",
                    "execOrder": 1,
                    "contextKeys": {
                        "voucher": "response.requests.request.get(0).id"
                    },
                    "retryAction": false
                }
            ]
        },
        {
            "id": 34426,
            "name": "UAT Vendor Redemption 2",
            "enabled": true,
            "responseKeys": [],
            "lastUpdatedOn": 1759740082000,
            "lastUpdatedOnDateTime": "2025-10-06T08:41:22Z",
            "redemptionType": "INTOUCH_REWARD",
            "vendorId": 430,
            "vendorName": "UAT Vendor 8",
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759740082000,
            "createdOnDateTime": "2025-10-06T08:41:22Z",
            "redemptionActionList": null
        },
        {
            "id": 34427,
            "name": "UAT Vendor Redemption 3",
            "enabled": true,
            "responseKeys": [
                "voucher"
            ],
            "lastUpdatedOn": 1759740368000,
            "lastUpdatedOnDateTime": "2025-10-06T08:46:08Z",
            "redemptionType": "INTOUCH_REWARD",
            "vendorId": 430,
            "vendorName": "UAT Vendor 8",
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759740368000,
            "createdOnDateTime": "2025-10-06T08:46:08Z",
            "redemptionActionList": [
                {
                    "id": 25861,
                    "name": "add good will points",
                    "enabled": true,
                    "apiType": "POST",
                    "apiUrl": "https://crm-nightly-new.cc.capillarytech.com/v1.1/request/add?program_id=2851",
                    "apiHeaders": {
                        "Authorization": "Basic bHVjaWF1dG9fdGlsbF8xMDoyMDJjYjk2MmFjNTkwNzViOTY0YjA3MTUyZDIzNGI3MA==",
                        "accept": "application/json",
                        "Content-Type": "application/json"
                    },
                    "apiBody": "{\"customFields_property\": {\"customField_1_property\": \"${customfield_CF1}\"}, \"transactionId_property\": \"${rewardTransactionId}\", \"fulfillmentStatus_property\": \"${fulfillmentStatus}\"}",
                    "execOrder": 1,
                    "contextKeys": {
                        "voucher": "response.requests.request.get(0).id"
                    },
                    "retryAction": false
                },
                {
                    "id": 25862,
                    "name": "add good will points",
                    "enabled": true,
                    "apiType": "POST",
                    "apiUrl": "https://crm-nightly-new.cc.capillarytech.com/v1.1/request/add?program_id=2851",
                    "apiHeaders": {
                        "Authorization": "Basic bHVjaWF1dG9fdGlsbF8xMDoyMDJjYjk2MmFjNTkwNzViOTY0YjA3MTUyZDIzNGI3MA==",
                        "accept": "application/json",
                        "Content-Type": "application/json"
                    },
                    "apiBody": "{\"customFields_property\": {\"customField_1_property\": \"${customfield_CF1}\"}, \"transactionId_property\": \"${rewardTransactionId}\", \"fulfillmentStatus_property\": \"${fulfillmentStatus}\"}",
                    "execOrder": 2,
                    "contextKeys": {
                        "voucher": "response.requests.request.get(0).id"
                    },
                    "retryAction": false
                },
                {
                    "id": 25863,
                    "name": "add good will points",
                    "enabled": true,
                    "apiType": "POST",
                    "apiUrl": "https://crm-nightly-new.cc.capillarytech.com/v1.1/request/add?program_id=2851",
                    "apiHeaders": {
                        "Authorization": "Basic bHVjaWF1dG9fdGlsbF8xMDoyMDJjYjk2MmFjNTkwNzViOTY0YjA3MTUyZDIzNGI3MA==",
                        "accept": "application/json",
                        "Content-Type": "application/json"
                    },
                    "apiBody": "{\"customFields_property\": {\"customField_1_property\": \"${customfield_CF1}\"}, \"transactionId_property\": \"${rewardTransactionId}\", \"fulfillmentStatus_property\": \"${fulfillmentStatus}\"}",
                    "execOrder": 3,
                    "contextKeys": {
                        "voucher": "response.requests.request.get(0).id"
                    },
                    "retryAction": false
                }
            ]
        },
        {
            "id": 34428,
            "name": "UAT Vendor Redemption 4",
            "enabled": true,
            "responseKeys": [
                "voucher"
            ],
            "lastUpdatedOn": 1759740733000,
            "lastUpdatedOnDateTime": "2025-10-06T08:52:13Z",
            "redemptionType": "INTOUCH_REWARD",
            "vendorId": 430,
            "vendorName": "UAT Vendor 8",
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759740733000,
            "createdOnDateTime": "2025-10-06T08:52:13Z",
            "redemptionActionList": [
                {
                    "id": 25864,
                    "name": "add good will points",
                    "enabled": true,
                    "apiType": "GET",
                    "apiUrl": "https://crm-nightly-new.cc.capillarytech.com/v1.1/request/add?program_id=2851",
                    "apiHeaders": {
                        "Authorization": "Basic bHVjaWF1dG9fdGlsbF8xMDoyMDJjYjk2MmFjNTkwNzViOTY0YjA3MTUyZDIzNGI3MA==",
                        "accept": "application/json",
                        "Content-Type": "application/json"
                    },
                    "apiBody": "{\"customFields_property\": {\"customField_1_property\": \"${customfield_CF1}\"}, \"transactionId_property\": \"${rewardTransactionId}\", \"fulfillmentStatus_property\": \"${fulfillmentStatus}\"}",
                    "execOrder": 3,
                    "contextKeys": {
                        "voucher": "response.requests.request.get(0).id"
                    },
                    "retryAction": false
                }
            ]
        },
        {
            "id": 34429,
            "name": "UAT Vendor Redemption 5",
            "enabled": true,
            "responseKeys": [
                "voucher"
            ],
            "lastUpdatedOn": 1759740863000,
            "lastUpdatedOnDateTime": "2025-10-06T08:54:23Z",
            "redemptionType": "INTOUCH_REWARD",
            "vendorId": 430,
            "vendorName": "UAT Vendor 8",
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759740863000,
            "createdOnDateTime": "2025-10-06T08:54:23Z",
            "redemptionActionList": [
                {
                    "id": 25865,
                    "name": "add good will points",
                    "enabled": true,
                    "apiType": "POST",
                    "apiUrl": "https://crm-nightly-new.cc.capillarytech.com/v1.1/request",
                    "apiHeaders": {
                        "Authorization": "Basic bHVjaWF1dG9fdGlsbF8xMDoyMDJjYjk2MmFjNTkwNzViOTY0YjA3MTUyZDIzNGI3MA==",
                        "accept": "application/json",
                        "Content-Type": "application/json"
                    },
                    "apiBody": "{\"customFields_property\": {\"customField_1_property\": \"${customfield_CF1}\"}, \"transactionId_property\": \"${rewardTransactionId}\", \"fulfillmentStatus_property\": \"${fulfillmentStatus}\"}",
                    "execOrder": 3,
                    "contextKeys": {
                        "voucher": "response.requests.request.get(0).id"
                    },
                    "retryAction": false
                }
            ]
        },
        {
            "id": 34430,
            "name": "UAT Vendor Redemption 5",
            "enabled": true,
            "responseKeys": [
                "voucher"
            ],
            "lastUpdatedOn": 1759740876000,
            "lastUpdatedOnDateTime": "2025-10-06T08:54:36Z",
            "redemptionType": "INTOUCH_REWARD",
            "vendorId": 430,
            "vendorName": "UAT Vendor 8",
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759740876000,
            "createdOnDateTime": "2025-10-06T08:54:36Z",
            "redemptionActionList": [
                {
                    "id": 25866,
                    "name": "add good will points",
                    "enabled": true,
                    "apiType": "POST",
                    "apiUrl": "https://crm-nightly-new.cc.capillarytech.com",
                    "apiHeaders": {
                        "Authorization": "Basic bHVjaWF1dG9fdGlsbF8xMDoyMDJjYjk2MmFjNTkwNzViOTY0YjA3MTUyZDIzNGI3MA==",
                        "accept": "application/json",
                        "Content-Type": "application/json"
                    },
                    "apiBody": "{\"customFields_property\": {\"customField_1_property\": \"${customfield_CF1}\"}, \"transactionId_property\": \"${rewardTransactionId}\", \"fulfillmentStatus_property\": \"${fulfillmentStatus}\"}",
                    "execOrder": 3,
                    "contextKeys": {
                        "voucher": "response.requests.request.get(0).id"
                    },
                    "retryAction": false
                }
            ]
        },
        {
            "id": 34431,
            "name": "UAT Vendor Redemption 5",
            "enabled": true,
            "responseKeys": [
                "voucher"
            ],
            "lastUpdatedOn": 1759741297000,
            "lastUpdatedOnDateTime": "2025-10-06T09:01:37Z",
            "redemptionType": "INTOUCH_REWARD",
            "vendorId": 430,
            "vendorName": "UAT Vendor 8",
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759741297000,
            "createdOnDateTime": "2025-10-06T09:01:37Z",
            "redemptionActionList": [
                {
                    "id": 25867,
                    "name": "add good will points",
                    "enabled": true,
                    "apiType": "POST",
                    "apiUrl": "https://crm-nightly-new.cc.capillarytech",
                    "apiHeaders": {
                        "Authorization": "Basic bHVjaWF1dG9fdGlsbF8xMDoyMDJjYjk2MmFjNTkwNzViOTY0YjA3MTUyZDIzNGI3MA==",
                        "accept": "application/json",
                        "Content-Type": "application/json"
                    },
                    "apiBody": "{\"customFields_property\": {\"customField_1_property\": \"${customfield_CF1}\"}, \"transactionId_property\": \"${rewardTransactionId}\", \"fulfillmentStatus_property\": \"${fulfillmentStatus}\"}",
                    "execOrder": 3,
                    "contextKeys": {
                        "voucher": "response.requests.request.get(0).id"
                    },
                    "retryAction": false
                }
            ]
        },
        {
            "id": 34432,
            "name": "UAT Vendor Redemption 5",
            "enabled": true,
            "responseKeys": [
                "voucher"
            ],
            "lastUpdatedOn": 1759741307000,
            "lastUpdatedOnDateTime": "2025-10-06T09:01:47Z",
            "redemptionType": "INTOUCH_REWARD",
            "vendorId": 430,
            "vendorName": "UAT Vendor 8",
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759741307000,
            "createdOnDateTime": "2025-10-06T09:01:47Z",
            "redemptionActionList": [
                {
                    "id": 25868,
                    "name": "add good will points",
                    "enabled": true,
                    "apiType": "POST",
                    "apiUrl": "https://cc.capillarytech",
                    "apiHeaders": {
                        "Authorization": "Basic bHVjaWF1dG9fdGlsbF8xMDoyMDJjYjk2MmFjNTkwNzViOTY0YjA3MTUyZDIzNGI3MA==",
                        "accept": "application/json",
                        "Content-Type": "application/json"
                    },
                    "apiBody": "{\"customFields_property\": {\"customField_1_property\": \"${customfield_CF1}\"}, \"transactionId_property\": \"${rewardTransactionId}\", \"fulfillmentStatus_property\": \"${fulfillmentStatus}\"}",
                    "execOrder": 3,
                    "contextKeys": {
                        "voucher": "response.requests.request.get(0).id"
                    },
                    "retryAction": false
                }
            ]
        },
        {
            "id": 34435,
            "name": "UAT Vendor Redemption 5",
            "enabled": true,
            "responseKeys": [
                "voucher"
            ],
            "lastUpdatedOn": 1759741603000,
            "lastUpdatedOnDateTime": "2025-10-06T09:06:43Z",
            "redemptionType": "INTOUCH_REWARD",
            "vendorId": 430,
            "vendorName": "UAT Vendor 8",
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759741603000,
            "createdOnDateTime": "2025-10-06T09:06:43Z",
            "redemptionActionList": [
                {
                    "id": 25870,
                    "name": "add good will points",
                    "enabled": true,
                    "apiType": "POST",
                    "apiUrl": "https://cc.capillarytech",
                    "apiHeaders": {
                        "Authorization": "",
                        "accept": "application/json",
                        "Content-Type": "application/json"
                    },
                    "apiBody": "{\"customFields_property\": {\"customField_1_property\": \"${customfield_CF1}\"}, \"transactionId_property\": \"${rewardTransactionId}\", \"fulfillmentStatus_property\": \"${fulfillmentStatus}\"}",
                    "execOrder": 3,
                    "contextKeys": {
                        "voucher": "response.requests.request.get(0).id"
                    },
                    "retryAction": false
                }
            ]
        },
        {
            "id": 34436,
            "name": "UAT Vendor Redemption 5",
            "enabled": true,
            "responseKeys": [
                "voucher"
            ],
            "lastUpdatedOn": 1759741612000,
            "lastUpdatedOnDateTime": "2025-10-06T09:06:52Z",
            "redemptionType": "INTOUCH_REWARD",
            "vendorId": 430,
            "vendorName": "UAT Vendor 8",
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759741612000,
            "createdOnDateTime": "2025-10-06T09:06:52Z",
            "redemptionActionList": null
        }
    ],
    "pagingDetails": {
        "last": false,
        "totalElements": 16,
        "totalPages": 2,
        "numberOfElements": 10,
        "first": true,
        "size": 10,
        "number": 0
    }
}

{
    "status": {
        "success": false,
        "code": 8000,
        "message": "Unable to fetch as Page number and size is invalid"
    },
    "redemptionList": null,
    "pagingDetails": null
}

{
    "status": {
        "success": false,
        "code": 2110,
        "message": "Invalid redemption(reward) type"
    },
    "redemptionList": null,
    "pagingDetails": null
}

{
    "status": {
        "success": true,
        "code": 5011,
        "message": "Vendor redemption fetched successfully"
    },
    "redemptionList": [
        {
            "id": 36988,
            "name": "UAT Vendor Redemption 6",
            "enabled": true,
            "responseKeys": [
                "voucher"
            ],
            "lastUpdatedOn": 1764153802000,
            "lastUpdatedOnDateTime": "2025-11-26T10:43:22Z",
            "redemptionType": "INTOUCH_REWARD",
            "vendorId": 430,
            "vendorName": "UAT Vendor 8",
            "createdBy": 75197372,
            "lastUpdatedBy": 75197372,
            "createdOn": 1764153802000,
            "createdOnDateTime": "2025-11-26T10:43:22Z",
            "redemptionActionList": [
                {
                    "id": 27322,
                    "name": "add good will points",
                    "enabled": true,
                    "apiType": "POST",
                    "apiUrl": "https://crm-nightly-new.cc.capillarytech.com/v1.1/request/add?program_id=2851",
                    "apiHeaders": {},
                    "apiBody": "{\"customFields_property\": {\"customField_1_property\": \"${customfield_CF1}\"}, \"transactionId_property\": \"${rewardTransactionId}\", \"fulfillmentStatus_property\": \"${fulfillmentStatus}\"}",
                    "execOrder": 1,
                    "contextKeys": {
                        "voucher": "response.requests.request.get(0).id"
                    },
                    "retryAction": false
                }
            ]
        },
        {
            "id": 36987,
            "name": "UAT Vendor Redemption 6",
            "enabled": true,
            "responseKeys": [
                "voucher"
            ],
            "lastUpdatedOn": 1764153001000,
            "lastUpdatedOnDateTime": "2025-11-26T10:30:01Z",
            "redemptionType": "INTOUCH_REWARD",
            "vendorId": 430,
            "vendorName": "UAT Vendor 8",
            "createdBy": 75197372,
            "lastUpdatedBy": 75197372,
            "createdOn": 1764153001000,
            "createdOnDateTime": "2025-11-26T10:30:01Z",
            "redemptionActionList": [
                {
                    "id": 27321,
                    "name": "add good will points",
                    "enabled": true,
                    "apiType": "POST",
                    "apiUrl": "https://crm-nightly-new.cc.capillarytech.com/v1.1/request/add?program_id=2851",
                    "apiHeaders": {
                        "Authorization": "Basic bHVjaWF1dG9fdGlsbF8xMDoyMDJjYjk2MmFjNTkwNzViOTY0YjA3MTUyZDIzNGI3MA==",
                        "accept": "application/json",
                        "Content-Type": "application/json"
                    },
                    "apiBody": "{\"customFields_property\": {\"customField_1_property\": \"${customfield_CF1}\"}, \"transactionId_property\": \"${rewardTransactionId}\", \"fulfillmentStatus_property\": \"${fulfillmentStatus}\"}",
                    "execOrder": 1,
                    "contextKeys": {
                        "voucher": "response.requests.request.get(0).id"
                    },
                    "retryAction": false
                }
            ]
        },
        {
            "id": 36986,
            "name": "UAT Vendor Redemption 6",
            "enabled": true,
            "responseKeys": [
                "voucher"
            ],
            "lastUpdatedOn": 1764152638000,
            "lastUpdatedOnDateTime": "2025-11-26T10:23:58Z",
            "redemptionType": "INTOUCH_REWARD",
            "vendorId": 430,
            "vendorName": "UAT Vendor 8",
            "createdBy": 75197372,
            "lastUpdatedBy": 75197372,
            "createdOn": 1764152638000,
            "createdOnDateTime": "2025-11-26T10:23:58Z",
            "redemptionActionList": [
                {
                    "id": 27320,
                    "name": "add good will points",
                    "enabled": true,
                    "apiType": "POST",
                    "apiUrl": "https://crm-nightly-new.cc.capillarytech.com/v1.1/request/add?program_id=2851",
                    "apiHeaders": {
                        "Authorization": "Basic bHVjaWF1dG9fdGlsbF8xMDoyMDJjYjk2MmFjNTkwNzViOTY0YjA3MTUyZDIzNGI3MA==",
                        "accept": "application/json",
                        "Content-Type": "application/json"
                    },
                    "apiBody": "{\"customFields_property\": {\"customField_1_property\": \"${customfield_CF1}\"}, \"transactionId_property\": \"${rewardTransactionId}\", \"fulfillmentStatus_property\": \"${fulfillmentStatus}\"}",
                    "execOrder": 1,
                    "contextKeys": {
                        "voucher": "response.requests.request.get(0).id"
                    },
                    "retryAction": false
                }
            ]
        },
        {
            "id": 34444,
            "name": "UAT Vendor Redemption 6 UAT Vendor Redemption 6 UAT Vendor Redemption 6 UAT Vendor Redemption 6 UAT Vendor Redemption 6 UAT Vendor Redemption 6 UAT Vendor Redemption 6 UAT Vendor Redemption 6 UAT Vendor Redemption 6 UAT Vendor Redemption 6 UAT Vendor Rede",
            "enabled": true,
            "responseKeys": [
                "voucher"
            ],
            "lastUpdatedOn": 1759750121000,
            "lastUpdatedOnDateTime": "2025-10-06T11:28:41Z",
            "redemptionType": "INTOUCH_REWARD",
            "vendorId": 430,
            "vendorName": "UAT Vendor 8",
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759750121000,
            "createdOnDateTime": "2025-10-06T11:28:41Z",
            "redemptionActionList": null
        },
        {
            "id": 34442,
            "name": "UAT Vendor Redemption 6",
            "enabled": true,
            "responseKeys": [
                "voucher"
            ],
            "lastUpdatedOn": 1759749265000,
            "lastUpdatedOnDateTime": "2025-10-06T11:14:25Z",
            "redemptionType": "INTOUCH_REWARD",
            "vendorId": 430,
            "vendorName": "UAT Vendor 8",
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759749265000,
            "createdOnDateTime": "2025-10-06T11:14:25Z",
            "redemptionActionList": [
                {
                    "id": 25874,
                    "name": "add good will points",
                    "enabled": true,
                    "apiType": "INVALID",
                    "apiUrl": "https://crm-nightly-new.cc.capillarytech.com/v1.1/request/add?program_id=2851",
                    "apiHeaders": {
                        "Authorization": "Basic bHVjaWF1dG9fdGlsbF8xMDoyMDJjYjk2MmFjNTkwNzViOTY0YjA3MTUyZDIzNGI3MA==",
                        "accept": "application/json",
                        "Content-Type": "application/json"
                    },
                    "apiBody": null,
                    "execOrder": 1,
                    "contextKeys": {
                        "voucher": "response.requests.request.get(0).id"
                    },
                    "retryAction": false
                }
            ]
        },
        {
            "id": 34437,
            "name": "UAT Vendor Redemption 5",
            "enabled": true,
            "responseKeys": [
                "voucher"
            ],
            "lastUpdatedOn": 1759741624000,
            "lastUpdatedOnDateTime": "2025-10-06T09:07:04Z",
            "redemptionType": "INTOUCH_REWARD",
            "vendorId": 430,
            "vendorName": "UAT Vendor 8",
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759741624000,
            "createdOnDateTime": "2025-10-06T09:07:04Z",
            "redemptionActionList": [
                {
                    "id": 25871,
                    "name": "add good will points",
                    "enabled": true,
                    "apiType": "POST",
                    "apiUrl": "https://cc.capillarytech",
                    "apiHeaders": {
                        "Authorization": "",
                        "accept": "application/json",
                        "Content-Type": "application/json"
                    },
                    "apiBody": "341431",
                    "execOrder": 3,
                    "contextKeys": {
                        "voucher": "response.requests.request.get(0).id"
                    },
                    "retryAction": false
                }
            ]
        },
        {
            "id": 34436,
            "name": "UAT Vendor Redemption 5",
            "enabled": true,
            "responseKeys": [
                "voucher"
            ],
            "lastUpdatedOn": 1759741612000,
            "lastUpdatedOnDateTime": "2025-10-06T09:06:52Z",
            "redemptionType": "INTOUCH_REWARD",
            "vendorId": 430,
            "vendorName": "UAT Vendor 8",
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759741612000,
            "createdOnDateTime": "2025-10-06T09:06:52Z",
            "redemptionActionList": null
        },
        {
            "id": 34435,
            "name": "UAT Vendor Redemption 5",
            "enabled": true,
            "responseKeys": [
                "voucher"
            ],
            "lastUpdatedOn": 1759741603000,
            "lastUpdatedOnDateTime": "2025-10-06T09:06:43Z",
            "redemptionType": "INTOUCH_REWARD",
            "vendorId": 430,
            "vendorName": "UAT Vendor 8",
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759741603000,
            "createdOnDateTime": "2025-10-06T09:06:43Z",
            "redemptionActionList": [
                {
                    "id": 25870,
                    "name": "add good will points",
                    "enabled": true,
                    "apiType": "POST",
                    "apiUrl": "https://cc.capillarytech",
                    "apiHeaders": {
                        "Authorization": "",
                        "accept": "application/json",
                        "Content-Type": "application/json"
                    },
                    "apiBody": "{\"customFields_property\": {\"customField_1_property\": \"${customfield_CF1}\"}, \"transactionId_property\": \"${rewardTransactionId}\", \"fulfillmentStatus_property\": \"${fulfillmentStatus}\"}",
                    "execOrder": 3,
                    "contextKeys": {
                        "voucher": "response.requests.request.get(0).id"
                    },
                    "retryAction": false
                }
            ]
        },
        {
            "id": 34432,
            "name": "UAT Vendor Redemption 5",
            "enabled": true,
            "responseKeys": [
                "voucher"
            ],
            "lastUpdatedOn": 1759741307000,
            "lastUpdatedOnDateTime": "2025-10-06T09:01:47Z",
            "redemptionType": "INTOUCH_REWARD",
            "vendorId": 430,
            "vendorName": "UAT Vendor 8",
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759741307000,
            "createdOnDateTime": "2025-10-06T09:01:47Z",
            "redemptionActionList": [
                {
                    "id": 25868,
                    "name": "add good will points",
                    "enabled": true,
                    "apiType": "POST",
                    "apiUrl": "https://cc.capillarytech",
                    "apiHeaders": {
                        "Authorization": "Basic bHVjaWF1dG9fdGlsbF8xMDoyMDJjYjk2MmFjNTkwNzViOTY0YjA3MTUyZDIzNGI3MA==",
                        "accept": "application/json",
                        "Content-Type": "application/json"
                    },
                    "apiBody": "{\"customFields_property\": {\"customField_1_property\": \"${customfield_CF1}\"}, \"transactionId_property\": \"${rewardTransactionId}\", \"fulfillmentStatus_property\": \"${fulfillmentStatus}\"}",
                    "execOrder": 3,
                    "contextKeys": {
                        "voucher": "response.requests.request.get(0).id"
                    },
                    "retryAction": false
                }
            ]
        },
        {
            "id": 34431,
            "name": "UAT Vendor Redemption 5",
            "enabled": true,
            "responseKeys": [
                "voucher"
            ],
            "lastUpdatedOn": 1759741297000,
            "lastUpdatedOnDateTime": "2025-10-06T09:01:37Z",
            "redemptionType": "INTOUCH_REWARD",
            "vendorId": 430,
            "vendorName": "UAT Vendor 8",
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759741297000,
            "createdOnDateTime": "2025-10-06T09:01:37Z",
            "redemptionActionList": [
                {
                    "id": 25867,
                    "name": "add good will points",
                    "enabled": true,
                    "apiType": "POST",
                    "apiUrl": "https://crm-nightly-new.cc.capillarytech",
                    "apiHeaders": {
                        "Authorization": "Basic bHVjaWF1dG9fdGlsbF8xMDoyMDJjYjk2MmFjNTkwNzViOTY0YjA3MTUyZDIzNGI3MA==",
                        "accept": "application/json",
                        "Content-Type": "application/json"
                    },
                    "apiBody": "{\"customFields_property\": {\"customField_1_property\": \"${customfield_CF1}\"}, \"transactionId_property\": \"${rewardTransactionId}\", \"fulfillmentStatus_property\": \"${fulfillmentStatus}\"}",
                    "execOrder": 3,
                    "contextKeys": {
                        "voucher": "response.requests.request.get(0).id"
                    },
                    "retryAction": false
                }
            ]
        },
        {
            "id": 34430,
            "name": "UAT Vendor Redemption 5",
            "enabled": true,
            "responseKeys": [
                "voucher"
            ],
            "lastUpdatedOn": 1759740876000,
            "lastUpdatedOnDateTime": "2025-10-06T08:54:36Z",
            "redemptionType": "INTOUCH_REWARD",
            "vendorId": 430,
            "vendorName": "UAT Vendor 8",
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759740876000,
            "createdOnDateTime": "2025-10-06T08:54:36Z",
            "redemptionActionList": [
                {
                    "id": 25866,
                    "name": "add good will points",
                    "enabled": true,
                    "apiType": "POST",
                    "apiUrl": "https://crm-nightly-new.cc.capillarytech.com",
                    "apiHeaders": {
                        "Authorization": "Basic bHVjaWF1dG9fdGlsbF8xMDoyMDJjYjk2MmFjNTkwNzViOTY0YjA3MTUyZDIzNGI3MA==",
                        "accept": "application/json",
                        "Content-Type": "application/json"
                    },
                    "apiBody": "{\"customFields_property\": {\"customField_1_property\": \"${customfield_CF1}\"}, \"transactionId_property\": \"${rewardTransactionId}\", \"fulfillmentStatus_property\": \"${fulfillmentStatus}\"}",
                    "execOrder": 3,
                    "contextKeys": {
                        "voucher": "response.requests.request.get(0).id"
                    },
                    "retryAction": false
                }
            ]
        },
        {
            "id": 34429,
            "name": "UAT Vendor Redemption 5",
            "enabled": true,
            "responseKeys": [
                "voucher"
            ],
            "lastUpdatedOn": 1759740863000,
            "lastUpdatedOnDateTime": "2025-10-06T08:54:23Z",
            "redemptionType": "INTOUCH_REWARD",
            "vendorId": 430,
            "vendorName": "UAT Vendor 8",
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759740863000,
            "createdOnDateTime": "2025-10-06T08:54:23Z",
            "redemptionActionList": [
                {
                    "id": 25865,
                    "name": "add good will points",
                    "enabled": true,
                    "apiType": "POST",
                    "apiUrl": "https://crm-nightly-new.cc.capillarytech.com/v1.1/request",
                    "apiHeaders": {
                        "Authorization": "Basic bHVjaWF1dG9fdGlsbF8xMDoyMDJjYjk2MmFjNTkwNzViOTY0YjA3MTUyZDIzNGI3MA==",
                        "accept": "application/json",
                        "Content-Type": "application/json"
                    },
                    "apiBody": "{\"customFields_property\": {\"customField_1_property\": \"${customfield_CF1}\"}, \"transactionId_property\": \"${rewardTransactionId}\", \"fulfillmentStatus_property\": \"${fulfillmentStatus}\"}",
                    "execOrder": 3,
                    "contextKeys": {
                        "voucher": "response.requests.request.get(0).id"
                    },
                    "retryAction": false
                }
            ]
        },
        {
            "id": 34428,
            "name": "UAT Vendor Redemption 4",
            "enabled": true,
            "responseKeys": [
                "voucher"
            ],
            "lastUpdatedOn": 1759740733000,
            "lastUpdatedOnDateTime": "2025-10-06T08:52:13Z",
            "redemptionType": "INTOUCH_REWARD",
            "vendorId": 430,
            "vendorName": "UAT Vendor 8",
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759740733000,
            "createdOnDateTime": "2025-10-06T08:52:13Z",
            "redemptionActionList": [
                {
                    "id": 25864,
                    "name": "add good will points",
                    "enabled": true,
                    "apiType": "GET",
                    "apiUrl": "https://crm-nightly-new.cc.capillarytech.com/v1.1/request/add?program_id=2851",
                    "apiHeaders": {
                        "Authorization": "Basic bHVjaWF1dG9fdGlsbF8xMDoyMDJjYjk2MmFjNTkwNzViOTY0YjA3MTUyZDIzNGI3MA==",
                        "accept": "application/json",
                        "Content-Type": "application/json"
                    },
                    "apiBody": "{\"customFields_property\": {\"customField_1_property\": \"${customfield_CF1}\"}, \"transactionId_property\": \"${rewardTransactionId}\", \"fulfillmentStatus_property\": \"${fulfillmentStatus}\"}",
                    "execOrder": 3,
                    "contextKeys": {
                        "voucher": "response.requests.request.get(0).id"
                    },
                    "retryAction": false
                }
            ]
        },
        {
            "id": 34427,
            "name": "UAT Vendor Redemption 3",
            "enabled": true,
            "responseKeys": [
                "voucher"
            ],
            "lastUpdatedOn": 1759740368000,
            "lastUpdatedOnDateTime": "2025-10-06T08:46:08Z",
            "redemptionType": "INTOUCH_REWARD",
            "vendorId": 430,
            "vendorName": "UAT Vendor 8",
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759740368000,
            "createdOnDateTime": "2025-10-06T08:46:08Z",
            "redemptionActionList": [
                {
                    "id": 25861,
                    "name": "add good will points",
                    "enabled": true,
                    "apiType": "POST",
                    "apiUrl": "https://crm-nightly-new.cc.capillarytech.com/v1.1/request/add?program_id=2851",
                    "apiHeaders": {
                        "Authorization": "Basic bHVjaWF1dG9fdGlsbF8xMDoyMDJjYjk2MmFjNTkwNzViOTY0YjA3MTUyZDIzNGI3MA==",
                        "accept": "application/json",
                        "Content-Type": "application/json"
                    },
                    "apiBody": "{\"customFields_property\": {\"customField_1_property\": \"${customfield_CF1}\"}, \"transactionId_property\": \"${rewardTransactionId}\", \"fulfillmentStatus_property\": \"${fulfillmentStatus}\"}",
                    "execOrder": 1,
                    "contextKeys": {
                        "voucher": "response.requests.request.get(0).id"
                    },
                    "retryAction": false
                },
                {
                    "id": 25862,
                    "name": "add good will points",
                    "enabled": true,
                    "apiType": "POST",
                    "apiUrl": "https://crm-nightly-new.cc.capillarytech.com/v1.1/request/add?program_id=2851",
                    "apiHeaders": {
                        "Authorization": "Basic bHVjaWF1dG9fdGlsbF8xMDoyMDJjYjk2MmFjNTkwNzViOTY0YjA3MTUyZDIzNGI3MA==",
                        "accept": "application/json",
                        "Content-Type": "application/json"
                    },
                    "apiBody": "{\"customFields_property\": {\"customField_1_property\": \"${customfield_CF1}\"}, \"transactionId_property\": \"${rewardTransactionId}\", \"fulfillmentStatus_property\": \"${fulfillmentStatus}\"}",
                    "execOrder": 2,
                    "contextKeys": {
                        "voucher": "response.requests.request.get(0).id"
                    },
                    "retryAction": false
                },
                {
                    "id": 25863,
                    "name": "add good will points",
                    "enabled": true,
                    "apiType": "POST",
                    "apiUrl": "https://crm-nightly-new.cc.capillarytech.com/v1.1/request/add?program_id=2851",
                    "apiHeaders": {
                        "Authorization": "Basic bHVjaWF1dG9fdGlsbF8xMDoyMDJjYjk2MmFjNTkwNzViOTY0YjA3MTUyZDIzNGI3MA==",
                        "accept": "application/json",
                        "Content-Type": "application/json"
                    },
                    "apiBody": "{\"customFields_property\": {\"customField_1_property\": \"${customfield_CF1}\"}, \"transactionId_property\": \"${rewardTransactionId}\", \"fulfillmentStatus_property\": \"${fulfillmentStatus}\"}",
                    "execOrder": 3,
                    "contextKeys": {
                        "voucher": "response.requests.request.get(0).id"
                    },
                    "retryAction": false
                }
            ]
        },
        {
            "id": 34426,
            "name": "UAT Vendor Redemption 2",
            "enabled": true,
            "responseKeys": [],
            "lastUpdatedOn": 1759740082000,
            "lastUpdatedOnDateTime": "2025-10-06T08:41:22Z",
            "redemptionType": "INTOUCH_REWARD",
            "vendorId": 430,
            "vendorName": "UAT Vendor 8",
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759740082000,
            "createdOnDateTime": "2025-10-06T08:41:22Z",
            "redemptionActionList": null
        },
        {
            "id": 34421,
            "name": "UAT Vendor Redemption 1",
            "enabled": true,
            "responseKeys": [
                "voucher"
            ],
            "lastUpdatedOn": 1759733970000,
            "lastUpdatedOnDateTime": "2025-10-06T06:59:30Z",
            "redemptionType": "INTOUCH_REWARD",
            "vendorId": 430,
            "vendorName": "UAT Vendor 8",
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759733970000,
            "createdOnDateTime": "2025-10-06T06:59:30Z",
            "redemptionActionList": [
                {
                    "id": 25858,
                    "name": "add good will points",
                    "enabled": true,
                    "apiType": "POST",
                    "apiUrl": "https://crm-nightly-new.cc.capillarytech.com/v1.1/request/add?program_id=2851",
                    "apiHeaders": {
                        "Authorization": "Basic bHVjaWF1dG9fdGlsbF8xMDoyMDJjYjk2MmFjNTkwNzViOTY0YjA3MTUyZDIzNGI3MA==",
                        "accept": "application/json",
                        "Content-Type": "application/json"
                    },
                    "apiBody": "{\"customFields_property\": {\"customField_1_property\": \"${customfield_CF1}\"}, \"transactionId_property\": \"${rewardTransactionId}\", \"fulfillmentStatus_property\": \"${fulfillmentStatus}\"}",
                    "execOrder": 1,
                    "contextKeys": {
                        "voucher": "response.requests.request.get(0).id"
                    },
                    "retryAction": false
                }
            ]
        }
    ],
    "pagingDetails": {
        "last": true,
        "totalElements": 16,
        "totalPages": 1,
        "numberOfElements": 16,
        "first": true,
        "size": 50,
        "number": 0
    }
}

Response parameters

Parameter Name	Description
status	Contains the status details of the vendor redemption fetch.
success	Indicates if the request was successful.
code	Status code of the response.
message	Message describing the status of the response.
redemptionList	List of vendor redemptions fetched in the response.
id	Unique ID of the vendor redemption.
name	Name of the vendor redemption.
enabled	Indicates if the vendor redemption is enabled.
responseKeys	responseKeys are the specific details we need from a vendor's response after an API call. For example, if the vendor returns multiple fields like id, status, and code, we only pick the important ones, like code and id, for our use.
lastUpdatedOn	Last updated date and time in Epoch time format.
lastUpdatedOnDateTime	Creation date and time of the field in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ)
redemptionActionList	List of redemption actions. You can specify `redemptionAction` using Create Vendor Redemption.
pagingDetails	Paging details of the vendor redemption list response.
lastUpdatedBy	The unique identifier of the user who last updated the vendor redemption record.
createdBy	The unique identifier of the user who created the vendor redemption.
createdOn	Indicates the timestamp when the vendor redemption was created. The timestamp is in Epoch time format.
createdOnDateTime	Indicates the date and time when the vendor redemption was created, formatted in ISO 8601.
vendorId	Unique identifier of the vendor.
vendorName	Name of the vendor.

API-specific error codes

Error Code	Description
8000	Unable to fetch as Page number and size is invalid
2110	Invalid redemption type

Note

Example request

Prerequisites

API Specification

Request query parameters

Example response

Response parameters

API-specific error codes

200200