Coupon Validation

This API is used to check whether a coupon is valid before processing its use.

The coupon is validated based on the following criteria:

  • Validity of the coupon number
  • Coupon validity period
  • Whether the usage limit has been exceeded
  • Whether the coupon has already been used

This API is available for Personal plans and above.

GET

/api/coupon/v1/validate?cpnNo={cpnNo}

{
    "cpnNo": "ZJLF0399WQBEQZJM"
}

Request Parameters

cpnNostringrequired
Coupon number. 
{
    "code": 0,
    "message": "",
    "result": {
        "cpnNo": "ZJLF0399WQBEQZJM",
        "nm": "$100 off cake coupon",
        "discTypeIdx": 457,
        "discCurrency": "USD",
        "formatDiscCurrency": "$60",
        "disc": 60.0,
        "strtYmd": "2025-01-01",
        "endYmd": "2025-12-31",
        "useLimit": 1,
        "imgUrl": "https://file.vivoldi.com/coupon/2024/11/08/lmTFkqLQdCzeBuPdONKG.webp",
        "onsiteYn": "Y",
        "onsitePwd": "123456",
        "memo": "60% off cake with coupon at the venue",
        "url": "",
        "userId": "user08",
        "userNm": "Emily",
        "userPhnno": "202-555-0173",
        "userEml": "test@gmail.com",
        "userEtc1": "",
        "userEtc2": "",
        "useCnt": 0,
        "regYmdt": "2024-11-17 17:29:25"
    }
}

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
Verification Success: The response returns the coupon information.
Verification Failure: The response is null, and the error message provides details.
cpnNostring
Coupon number.
nmstring
Coupon name.
discTypeIdxinteger
Discount type. (457: Percentage discount %, 458: Fixed amount discount)
discdouble
For percentage (457): range 1–100%. For fixed amount (458): enter amount.
discCurrencystring
Currency unit. Required when using fixed amount discount (discTypeIdx:458).
formatDiscCurrencystring
Currency symbol.
strtYmddate
Coupon valid start date.
endYmddate
Coupon expiration date.
useLimitinteger
Coupon usage limit. (0: Unlimited, 1–5: Limited number of uses)
imgUrlstring
Coupon image URL.
onsiteYnstring
Onsite coupon option. Determines whether the “Use Coupon” button is displayed on the coupon page.
Required when coupons are redeemed in offline stores.
onsitePwdstring
Onsite coupon password. Password required to redeem coupon.
memostring
Internal reference note.
urlstring
If a URL is entered, a “Go to Use Coupon” button will be shown on the coupon page.
Clicking the button or the coupon image redirects to the URL.
userIdstring
Used to manage the recipient of the coupon.
Required if coupon usage limit is set to 2–5.
Typically enter the website member’s login ID or English name.
userNmstring
Coupon user name. For internal management.
userPhnnostring
Coupon user contact number. For internal management.
userEmlstring
Coupon user email. For internal management.
userEtc1string
Additional internal field.
userEtc2string
Additional internal field.
useCntinteger
Number of times the coupon has been used.
regYmdtdatetime
Coupon creation date. Example: 2025-07-21 11:50:20