Skip to main content

Get Campaign Reward

This API is used to retrieve detailed information about a campaign reward generation transaction by providing the transaction ID.

Endpoint

URL : {BaseURL}/api/v1/campaign-rewards/generate-detail/{transactionId}
Method : GET
Header : Content-Type : Application/JSON

Request

This section describes the request parameters and provides examples of JSON requests used to retrieve detailed information about a campaign reward generation transaction by transaction ID.
Sample JSON Request
curl --location --globoff '{{BaseURL}}/api/v1/api/v1/campaign-rewards/generate-detail/{transactionId}' \
--header 'accept: application/json'

Response

This section describes the response parameters and provides JSON response examples returned by the API when retrieving detailed information about a campaign reward generation transaction.
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.
idString
(36)
YESUUIDUnique identifier for the campaign.
refIdString
(36)
YESUUIDUnique reference ID from campaign reward generate.
catalogIdString
(36)
YESUUIDUnique identifier for the catalog.
voucherIdString
(36)
YESUUIDUnique identifier for the voucher.
voucherPhotoString
(500)
YESURLURL of the voucher image.
voucherNameString
(200)
YESAlphanumericName of the voucher that was redeemed by the customer.
voucherTypeString
(200)
YESAlphanumericType of voucher (e.g., “PPOB” and “Non PPOB”).
voucherCategoryString
(200)
YESAlphanumericVoucher classification/category
validUntilString
(32)
YESTimestampExpiration date of voucher
descriptionString
(2000)
YESTextDescription of the Campaign Reward (if any).
howToRedeemString
(2000)
YESTextInstructions to redeem the voucher
termsString
(2000)
YESTextTerms & conditions
clientLogoString
(500)
NOURLURL to the client logo
customFieldString
(200)
NOAlphanumericAdditional custom field (optional)
retryCountInteger
(100)
YESNumericNumber of retry attempts
redeemIDString
(36)
NOUUIDUnique identifier for the redeem
redeemTimeString
(32)
NOTimestampTime when voucher redeemed
redeemValueInteger
(10)
NONumericRedemption amount / value
customerIDString
(36)
NOUUIDUnique identifier for the customer
storeCodeString
(200)
NOAlphanumericCode of store
statusString
(200)
YESAlphanumericStatus of the reward generation (“generated”, etc.)
errorReasonString
(500)
NOTextError details if generation failed
Sample JSON Response
{
"requestID": "094ed79e-d6ba-49bb-b27a-dd843e66ayyy",
"rc": 200,
"message": "success",
"data": {
"id": "31d27f82-234d-4f6e-a89e-43084160dyyy",
"refId": "50688dda-4abf-4e50-a803-8a6c231d2b96",
"catalogId": "c2c4deea-d46f-438e-adae-2e56ded80f42",
"voucherId": "7b1bd296-2700-483c-8bcd-654fdf9c3yyy",
"voucherPhoto": "{{BaseURL}}/api/service-product/api/v1/product-non-ppob/image/9db7027f-3609-4dc1-b8d0-c30845ed9db8.png",
"voucherName": "Ace Hardware Rp 100.000",
"voucherType": "Non PPOB",
"voucherCategory": "Consumer goods",
"validUntil": "2026-12-31T00:00:00+07:00",
"description": "MAP Gift Voucher is the official gift voucher of PT Mitra Adiperkasa Tbk. Accepted in 2,900 retail stores managed under MAP Group Indonesia, with a wide range of products and brands. It is a perfect gift for Birthdays, Wedding Anniversaries, Valentines, Holidays, Festive occasions, at any time, anywhere!",
"howToRedeem": "Enter the link to digital voucher landing page\nClick button “Redeem Voucher”\nComplete requirement field\nClick button “Redeem Now”\nShow the barcodeEnjoy your voucher",
"terms": "Use the voucher by showing the voucher from the MAP Club application at the cashier (Do not press the USE button before the cashier)\nVouchers are valid every day, including Saturdays, Sundays and national holidays.\nVouchers can be used to purchase discounted products and other promotional products.\nVouchers are valid for purchasing all products and can be used without a minimum purchase.\nThe difference in Rupiah value that arises due to the value of the voucher used being higher than the value of the goods purchased, cannot be returned in any form.\nVouchers can only be used in offline stores and cannot be used in online stores\nVouchers that have been purchased cannot be returned or exchanged for cash.\nPT Mitra Adiperkasa Tbk has the right to change the Terms & Conditions for using vouchers without prior notification.",
"clientLogo": "",
"customField": "",
"retryCount": 0,
"redeemID": "",
"redeemTime": "",
"redeemValue": null,
"customerID": null,
"storeCode": null,
"status": "generated",
"errorReason": null
}
}