Validasi Stempel

API ini digunakan untuk memeriksa apakah stempel masih valid sebelum menambah, menghapus, atau memproses penggunaan hadiah.

Validasi dilakukan berdasarkan kriteria berikut:

  • Validitas Stamp IDX
  • Periode validitas stempel
  • Status aktivasi stempel
  • Apakah hadiah sudah digunakan

API ini tersedia untuk paket Personal ke atas.

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
Kode respons: 0 = Berhasil, nilai lain = Error
messagestring
Pesan respons. Jika kode tidak sama dengan 0, pesan kesalahan akan dikembalikan.
resultobject
Jika verifikasi berhasil, respons akan berisi informasi stempel.
Jika gagal, nilai respons akan menjadi null dan pesan kesalahan akan menunjukkan penyebabnya.
stampIdx integer
Stamp IDX.
domain string
Domain cap.
cardIdx integer
Card IDX.
cardNm string
Nama kartu.
cardTtl string
Judul kartu.
stamps integer
Jumlah cap yang telah dikumpulkan sejauh ini.
maxStamps integer
Jumlah maksimum cap pada kartu.
stampUrl string
URL halaman cap.
url string
URL tujuan yang akan dibuka saat tombol di halaman cap diklik.
strtYmd date
Tanggal mulai masa berlaku cap.
endYmd date
Tanggal berakhirnya masa berlaku cap.
onsiteYn string
Enum:
YN
Menunjukkan apakah penambahan cap di lokasi diaktifkan.
Jika nilainya Y, staf toko dapat menambahkan cap langsung di tempat.
onsitePwd string
Kata sandi untuk penambahan cap di lokasi.
Diperlukan saat menggunakan API penggunaan manfaat jika opsi di lokasi diaktifkan (Y).
memo string
Catatan internal untuk referensi.
activeYn string
Enum:
YN
Menunjukkan apakah cap aktif.
Jika dinonaktifkan, pelanggan tidak dapat menggunakan cap tersebut.
userId string
ID pengguna. Digunakan untuk mengelola penerima cap.
Biasanya ini adalah ID login anggota situs web.
Jika tidak diatur, sistem akan membuat ID pengguna secara otomatis.
userNm string
Nama pengguna. Hanya untuk keperluan internal.
userPhnno string
Nomor telepon pengguna. Hanya untuk keperluan internal.
userEml string
Alamat email pengguna. Hanya untuk keperluan internal.
userEtc1 string
Kolom tambahan untuk manajemen internal.
userEtc2 string
Kolom tambahan untuk manajemen internal.
stampImgUrl string
URL gambar cap.
regYmdt datetime
Tanggal pembuatan cap. Contoh: 2025-07-21 11:50:20