쿠폰 검증

이 API는 쿠폰 사용 처리 전에 쿠폰이 유효한지 확인하는 데 사용됩니다.

다음 기준으로 쿠폰의 유효성을 검증합니다:

  • 쿠폰 번호의 유효성
  • 쿠폰 유효기간
  • 쿠폰 사용 가능 횟수 초과 여부
  • 이미 사용된 쿠폰 여부

이 API는 퍼스널 요금제 이상에서만 제공됩니다.

GET

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

{
    "cpnNo": "ZJLF0399WQBEQZJM"
}

Request Parameters

cpnNostringrequired
쿠폰 번호. 
{
    "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
응답 코드: 0 = 성공, 그 외 값 = 오류
messagestring
응답 메시지입니다. 응답 코드가 0이 아니면, 오류 관련 메시지가 반환됩니다.
resultobject
검증 성공 시: 응답 값에 쿠폰 정보가 반환됩니다.
검증 실패 시: 응답 값은 null이며, 오류 메시지를 통해 확인할 수 있습니다.
cpnNostring
쿠폰 번호.
nmstring
쿠폰 이름.
discTypeIdxinteger
Default:457
Enum:
457458
할인 유형. (457:요율 할인 %, 458:금액 할인)
discdouble
Default:0
할인율(457)은 1~100% 범위, 할인금액(458)은 금액 입력
discCurrencystring
Default:KRW
Enum:
KRWCADCNYEURGBPIDRJPYMURRUBSGDUSD
화폐 단위. 금액 할인(discTypeIdx:458) 사용시 필수.
formatDiscCurrencystring
화폐 통화 기호.
strtYmddate
쿠폰 유효 시작일.
endYmddate
쿠폰 유효 만료일.
useLimitinteger
Default:1
Enum:
012345
쿠폰 사용 가능 횟수. (0:무제한, 1~5: 횟수 제한)
imgUrlstring
쿠폰 이미지 URL.
onsiteYnstring
Default:N
Enum:
YN
현장쿠폰 여부. 쿠폰 페이지에 “쿠폰 사용” 버튼 표시 여부.
오프라인 매장에서 직원이 쿠폰 사용 시 필요.
onsitePwdstring
현장쿠폰 비밀번호. 쿠폰 사용 시 필요한 비밀번호.
memostring
내부 참고용 메모.
urlstring
URL 입력 시 쿠폰 페이지에 “쿠폰 사용하러 가기” 버튼이 표시됩니다.
버튼 또는 쿠폰 이미지 클릭 시 해당 URL로 리디렉션.
userIdstring
쿠폰 발급 대상자를 관리하는 데 사용됩니다.
쿠폰 사용 가능 횟수가 2~5로 설정된 경우 반드시 입력해야 하며, 일반적으로 웹사이트 회원의 로그인 ID 또는 영문 이름을 입력합니다.
userNmstring
쿠폰 사용자 이름. 내부 관리용.
userPhnnostring
쿠폰 사용자 연락처. 내부 관리용.
userEmlstring
쿠폰 사용자 이메일. 내부 관리용.
userEtc1string
추가 내부 관리용 필드.
userEtc2string
추가 내부 관리용 필드.
useCntinteger
쿠폰 사용 횟수.
regYmdtdatetime
쿠폰 생성 날짜. 예: 2025-07-21 11:50:20