Redeem Campaign

This API is used to Redeem a campaign reward voucher for a customer.

Endpoint

URL : {BaseURL}/api/v1/campaign-reward/redeem
Method : POST
Header : Content-Type : Application/JSON

Request

This section describes the request parameters and provides examples of JSON requests used to redeem a campaign reward voucher.

Description Parameter Request

Field	Data Type	Mandatory	Format	Description
customerId	String (36)	YES	UUID	Unique identifier for the customer.
refId	String (36)	YES	UUID	Unique identifier for the Redeem campaign.
storeCode	String (200)	YES	Alphanumeric	Unique store code where redeem is processed.
voucherId	String (36)	YES	UUID	Unique identifier for the voucher.

Sample JSON Request

curl --location --globoff '{{BaseURL}}/api/v1/api/v1/campaign-rewards/redeem' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
	"customerId": "08123456789",
	"refId": "50688dda-4abf-4e50-a803-8a6c231d2b96",
	"storeCode": "SC010",
	"voucherId": "7b1bd296-2700-483c-8bcd-654fdf9c3yyy"
}'

---

Response

This section describes the response parameters and provides JSON response examples returned after a campaign reward voucher is successfully redeemed.

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	Detailed information from data.

Sample JSON Response

{
	"requestID": "0c867569-3f80-4855-bfed-827c65a6158e",
	"rc": 200,
	"message": "success",
	"data": null
}