Reedem Claim Reward
This API is used to handle the process of claiming a reward that has been previously purchased by the customer.
Endpoint
URL : {BaseURL}/api/v1/rewards/redeem
Method : POST
Header : Content-Type : Application/JSON
Header : Authorization : {{pwa_token}}
Request
This section describes the request parameters and provides examples of JSON requests used to claim a purchased reward.
Description Parameter Request
| Field | Data Type | Mandatory | Format | Description |
|---|---|---|---|---|
| refID | String (15) | YES | Alphanumeric | The reference ID of the reward or voucher to be redeemed. |
| storeCode | String (20) | NO | Alphanumeric | Code of the store where redemption occurs (if applicable). Leave empty if not used. |
| customerID | String (36) | NO | UUID | Unique identifier of the customer. Optional if the token already contains this info. |
| rewardID | String (36) | YES | UUID | Unique identifier of the reward item to be redeemed. |
Sample JSON Request
curl --location --globoff '{{BaseURL}}/api/v1/rewards/redeem' \
--header 'Authorization: {{pwa_token}}' \
--header 'Content-Type: application/json' \
--data '{
"refID": "PZNBX7K9QWMAO44",
"storeCode": "",
"customerID": "",
"rewardID": "24381878-3c12-4c42-b038-b3340945fyyy"
}'
Response
This section describes the response parameters and provides JSON response examples returned by the API after claiming a purchased reward.
Description Parameter Response
| Field | Data Type | Mandatory | Format | Description |
|---|---|---|---|---|
| requestID | String (36) | YES | UUID | Unique identifier for the request. |
| rc | Integer (3) | YES | Numeric | Response code indicating the status of the operation. |
| Message | String (200) | YES | Alphanumeric | A descriptive message regarding the response. |
| data | JSON Object | YES | JSON Object | Detail information from data. |
| id | String (36) | YES | UUID | Unique identifier for the redemption record. |
| voucherName | String (200) | YES | Alphanumeric | Name of the voucher that was redeemed by the customer. |
| redeemTime | String (32) | YES | Timestamp | The exact date and time when the voucher was successfully redeemed. |
| voucherRefID | String (15) | YES | Alphanumeric | Reference code or external identifier of the redeemed voucher. May be used for verification with third-party systems. |
| status | String (200) | YES | Alphanumeric | indicates the redemption result, e.g., success, pending, or failed. |
Sample JSON Response
{
"requestID": "a5b0b920-9dcf-4374-a981-1f6160c902b3",
"rc": 200,
"message": "success",
"data": {
"id": "58f8a565-c27a-47d6-98d5-49ced2c2ab67",
"voucherName": "Planet Box 100.000",
"redeemTime": "2025-10-14T08:50:11+07:00",
"voucherRefID": "PZNBX7K9QWMAO44",
"status": "success"
}
}