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

stampIdxintegerrequired
스템프 IDX. 
{
    "code": 0,
    "message": "",
    "result": {
        "stampIdx": 16,
        "domain": "https://vvd.bz",
        "cardIdx": 1,
        "cardNm": "아메리카노 10잔 적립",
        "cardTtl": "도장을 10개 모으면 아메리카노 1잔 무료",
        "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.
stampIdxinteger
Stamp IDX.
domainstring
Stamp domain.
cardIdxinteger
Card IDX.
cardNmstring
Card name.
cardTtlstring
Card title.
stampsinteger
Number of collected stamps so far.
maxStampsinteger
Maximum number of stamps for the card.
stampUrlstring
URL of the stamp page.
urlstring
The URL to which the user is redirected when clicking the button on the stamp page.
strtYmddate
Stamp validity start date.
endYmddate
Stamp expiration date.
onsiteYnstring
Enum:
YN
Indicates whether on-site accumulation is enabled. If the value is Y, store staff can add stamps at the location.
onsitePwdstring
On-site accumulation password. Required when on-site accumulation (Y) is enabled for using the stamp reward API.
memostring
Internal memo for reference.
activeYnstring
Enum:
YN
Indicates whether the stamp is active. If deactivated, customers cannot use the stamp.
userIdstring
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.
userNmstring
User name. For internal management.
userPhnnostring
User phone number. For internal management.
userEmlstring
User email address. For internal management.
userEtc1string
Additional internal management field.
userEtc2string
Additional internal management field.
stampImgUrlstring
URL of the stamp image.
regYmdtdatetime
Stamp creation date. Example: 2025-07-21 11:50:20