Status Campaign Reward
This API is used to check the status of a campaign reward redemption using reference ID.
Endpoint
URL : {BaseURL}/api/v1/campaign-rewards/redeem-status/{{refID}}
Method : GET
Header : Content-Type : Application/JSON
Request
This section describes the request parameters and provides examples of JSON requests used to check the status of a campaign reward redemption.
Sample JSON Request
curl --location --globoff '{{BaseURL}}/api/v1/api/v1/campaign-rewards/redeem-status/\{{refId}}' \
--header 'accept: application/json'
Response
This section describes the response parameters and provides JSON response examples returned when checking the status of campaign reward redemption.
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. |
| refId | String (36) | YES | UUID | Unique reference identifier for the redemption transaction. |
| status | String (200) | YES | Alphanumeric | Indicates the redemption result, e.g., success, pending, or failed. |
Sample JSON Response
{
"requestID": "094ed79e-d6ba-49bb-b27a-dd843e66ayyy",
"rc": 200,
"message": "success",
"data": {
"refId": "50688dda-4abf-4e50-a803-8a6c231d2yyy",
"status": "redeemed"
}
}