Validasi Kupon

API ini digunakan untuk memeriksa apakah kupon masih berlaku sebelum diproses.

Kupon divalidasi berdasarkan kriteria berikut:

  • Validitas nomor kupon
  • Periode berlaku kupon
  • Apakah batas penggunaan telah terlampaui
  • Apakah kupon sudah digunakan

API ini tersedia untuk paket Personal ke atas.

GET

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

{
    "cpnNo": "ZJLF0399WQBEQZJM"
}

Request Parameters

cpnNostringrequired
Nomor kupon. 
{
    "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
Kode respons: 0 = Berhasil, nilai lain = Error
messagestring
Pesan respons. Jika kode tidak sama dengan 0, pesan kesalahan akan dikembalikan.
resultobject
Berhasil diverifikasi: Respons mengembalikan informasi kupon.
Gagal diverifikasi: Respons bernilai null dan dapat dilihat melalui pesan kesalahan.
cpnNostring
Nomor kupon.
nmstring
Nama kupon.
discTypeIdxinteger
Jenis diskon. (457: diskon persentase %, 458: diskon nominal)
discdouble
Untuk persentase (457): rentang 1–100%. Untuk nominal (458): masukkan jumlah.
discCurrencystring
Mata uang. Wajib diisi jika menggunakan diskon nominal (discTypeIdx:458).
formatDiscCurrencystring
Simbol mata uang.
strtYmddate
Tanggal mulai berlaku kupon.
endYmddate
Tanggal kedaluwarsa kupon.
useLimitinteger
Batas penggunaan kupon. (0: tanpa batas, 1–5: jumlah penggunaan terbatas)
imgUrlstring
URL gambar kupon.
onsiteYnstring
Kupon di lokasi. Menentukan apakah tombol “Gunakan Kupon” ditampilkan di halaman kupon.
Dibutuhkan saat kupon digunakan di toko offline.
onsitePwdstring
Kata sandi kupon di lokasi. Diperlukan untuk menggunakan kupon.
memostring
Catatan referensi internal.
urlstring
Jika URL dimasukkan, tombol “Pergi Gunakan Kupon” akan ditampilkan di halaman kupon.
Mengklik tombol atau gambar kupon akan mengarahkan ke URL tersebut.
userIdstring
Digunakan untuk mengelola penerima kupon.
Wajib diisi jika batas penggunaan kupon diatur 2–5 kali.
Biasanya diisi dengan ID login anggota situs atau nama dalam bahasa Inggris.
userNmstring
Nama pengguna kupon. Untuk penggunaan internal.
userPhnnostring
Nomor telepon pengguna kupon. Untuk penggunaan internal.
userEmlstring
Email pengguna kupon. Untuk penggunaan internal.
userEtc1string
Bidang tambahan untuk penggunaan internal.
userEtc2string
Bidang tambahan untuk penggunaan internal.
useCntinteger
Jumlah penggunaan kupon.
regYmdtdatetime
Tanggal pembuatan kupon. Contoh: 2025-07-21 11:50:20