Stamp Validation

This API is used to verify whether a stamp is valid before adding or removing stamps, or processing a reward redemption.

Validation is performed based on the following criteria:

  • Validity of the Stamp IDX
  • Stamp validity period
  • Stamp activation status
  • Whether the reward has already been redeemed

This API is available for Personal plans and higher.

GET

/api/stamp/v1/validate?stampIdx={stampIdx} 

{
    "stampIdx": 274
}

Request Parameters

stampIdx integer required
스템프 IDX. 
{
    "code": 0,
    "message": "",
    "result": {
        "stampIdx": 16,
        "domain": "https://vvd.bz",
        "cardIdx": 1,
        "cardNm": "Accumulate 10 Americanos",
        "cardTtl": "Collect 10 stamps to get one free Americano.",
        "stamps": 10,
        "maxStamps": 12,
        "stampUrl": "https://vvd.bz/stamp/274",
        "url": "https://myshopping.com",
        "strtYmd": "2025-01-01",
        "endYmd": "2026-12-31",
        "onsiteYn": "Y",
        "onsitePwd": "123456",
        "memo": null,
        "activeYn": "Y",
        "userId": "NKkDu9X4p4mQ",
        "userNm": null,
        "userPhnno": null,
        "userEml": null,
        "userEtc1": null,
        "userEtc2": null,
        "stampImgUrl": "https://cdn.vivoldi.com/www/image/icon/stamp/icon.stamp.1.webp",
        "regYmdt": "2025-10-30 05:11:35",
        "payloadVersion": "v1"
    }
}

Response Parameters

codeinteger
Response code: 0 = Success, any other value = Error
messagestring
Response message. If the response code is not 0, an error-related message is returned.
resultobject
If the verification succeeds, the response will include the stamp information.
If the verification fails, the response value will be null, and the error message will indicate the cause.
stampIdx integer
Stamp IDX.
domain string
Stamp domain.
cardIdx integer
Card IDX.
cardNm string
Card name.
cardTtl string
Card title.
stamps integer
Number of collected stamps so far.
maxStamps integer
Maximum number of stamps for the card.
stampUrl string
URL of the stamp page.
url string
The URL to which the user is redirected when clicking the button on the stamp page.
strtYmd date
Stamp validity start date.
endYmd date
Stamp expiration date.
onsiteYn string
Enum:
YN
Indicates whether on-site accumulation is enabled. If the value is Y, store staff can add stamps at the location.
onsitePwd string
On-site accumulation password. Required when on-site accumulation (Y) is enabled for using the stamp reward API.
memo string
Internal memo for reference.
activeYn string
Enum:
YN
Indicates whether the stamp is active. If deactivated, customers cannot use the stamp.
userId string
User ID. Used to manage the recipient of the stamp.
Typically, this corresponds to the website member’s login ID.
If not set, the system automatically generates a user ID.
userNm string
User name. For internal management.
userPhnno string
User phone number. For internal management.
userEml string
User email address. For internal management.
userEtc1 string
Additional internal management field.
userEtc2 string
Additional internal management field.
stampImgUrl string
URL of the stamp image.
regYmdt datetime
Stamp creation date. Example: 2025-07-21 11:50:20