Skip to main content

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
FieldData TypeMandatoryFormatDescription
requestIDString
(36)
YESUUIDUnique identifier for the request.
rcInteger
(3)
YESNumericResponse code indicating the status of the operation.
messageString
(200)
YESAlphanumericA descriptive message regarding the response.
dataJSON ObjectYESJSON ObjectDetail information from data.
refIdString
(36)
YESUUIDUnique reference identifier for the redemption transaction.
statusString
(200)
YESAlphanumericIndicates 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"
}
}