Feat/enakgame #44
@@ -1,377 +0,0 @@
|
|||||||
# API EnakPoint & EnakCoin
|
|
||||||
|
|
||||||
30 Sep 2026
|
|
||||||
|
|
||||||
Semua endpoint EnakPoint (`POINT`, hanya untuk ditukar ke voucher) dan EnakCoin (`COIN`, untuk game dan ditukar ke EnakPoint) ada di bawah base URL `/api/v1`, memakai satu format response, dan semua jumlah berupa bilangan bulat.
|
|
||||||
|
|
||||||
> **Perubahan 7 Okt 2026:** bayar order dengan EnakPoint sudah dihapus, karena EnakPoint sekarang hanya bisa ditukar ke voucher: tidak bisa dipakai sebagai alat bayar dan tidak bisa dicairkan ([`enakgame-prd.md`](./enakgame-prd.md) §3.2). Endpoint dan field yang ikut dihapus ada di Referensi → Endpoint dan field yang dihapus.
|
|
||||||
|
|
||||||
## Konvensi umum
|
|
||||||
|
|
||||||
| Klien | Autentikasi | Prefix |
|
|
||||||
| --- | --- | --- |
|
|
||||||
| Customer app / self-order | `Authorization: Bearer <token customer>` | `/api/v1/customer` |
|
|
||||||
| POS | Token user (kasir/manager) | `/api/v1` |
|
|
||||||
| Dashboard | Token user, role Admin atau Manager | `/api/v1/marketing`, `/api/v1/outlets` |
|
|
||||||
|
|
||||||
**Format response.** Sukses: `{"success": true, "data": {…}, "errors": null}`. Gagal: `{"success": false, "data": null, "errors": [{"code": "304", "entity": "wallet_service", "cause": "…"}]}`. Tampilkan `cause` sebagai alasan penolakan.
|
|
||||||
|
|
||||||
| `code` | HTTP | Arti |
|
|
||||||
| --- | --- | --- |
|
|
||||||
| `303`, `310` | 400 | Body atau parameter tidak lengkap / salah format |
|
|
||||||
| `304` | 400 | Ditolak aturan bisnis (saldo kurang, di luar batas, dst.) |
|
|
||||||
| `404` | 404 | Tidak ditemukan, juga untuk data milik customer atau organisasi lain |
|
|
||||||
| `429` | 429 | OTP diminta ulang terlalu cepat |
|
|
||||||
| `PIN_NOT_SET` | 403 | Customer belum membuat PIN |
|
|
||||||
| `PIN_INVALID` | 400 | PIN salah |
|
|
||||||
| `PIN_LOCKED` | 423 | PIN terkunci 30 menit setelah 5 kali salah |
|
|
||||||
| `TRANSFER_BLOCKED` | 403 | Transfer ditahan 24 jam setelah reset PIN |
|
|
||||||
| `900` | 500 | Kesalahan server |
|
|
||||||
|
|
||||||
**Error PIN** membawa `data` yang tidak `null`: `{"code": "PIN_INVALID", "remaining_attempts": 3}`, `{"code": "PIN_LOCKED", "locked_until": "…"}`, atau `{"code": "TRANSFER_BLOCKED", "transfer_blocked_until": "…"}`. Endpoint yang menerima `pin` bisa mengembalikan salah satunya. PIN selalu dikirim sebagai string 6 digit.
|
|
||||||
|
|
||||||
**Idempotency.** Exchange dan transfer wajib header `Idempotency-Key` (maks. 50 karakter, `X-Idempotency-Key` juga diterima): satu key per percobaan, dan key yang sama dipakai ulang saat retry. Retry mengembalikan hasil pertama dengan `replayed: true`.
|
|
||||||
|
|
||||||
**Waktu.** Tanggal kedaluwarsa dan filter tanggal memakai WIB. Saldo berlaku sampai 23:59:59 WIB pada tanggal kedaluwarsanya.
|
|
||||||
|
|
||||||
## Customer app: saldo & riwayat
|
|
||||||
|
|
||||||
| Method | Path | Keterangan |
|
|
||||||
| --- | --- | --- |
|
|
||||||
| GET | `/customer/wallet` | Saldo, nilai rupiah, kedaluwarsa terdekat, 5 mutasi terakhir |
|
|
||||||
| GET | `/customer/wallet/transactions` | Riwayat mutasi, dengan pagination dan filter |
|
|
||||||
| GET | `/customer/wallet/expiring` | Saldo yang akan kedaluwarsa, per currency dan tanggal |
|
|
||||||
| PUT | `/customer/devices` | Daftarkan token FCM device |
|
|
||||||
| DELETE | `/customer/devices/:device_id` | Hapus device saat logout |
|
|
||||||
| GET | `/customer/outlets` | Outlet aktif di organisasi customer, dengan `earns_points`, `earns_coins` |
|
|
||||||
| GET | `/customer/orders` | Riwayat order customer (`page`, `limit`), dengan `points_earned` / `coins_earned` |
|
|
||||||
| GET | `/customer/orders/:id` | Detail order: item, pembayaran, EnakPoint/EnakCoin yang didapat; order customer lain → `404` |
|
|
||||||
|
|
||||||
Registrasi (`POST /customer-auth/register/start`) menerima `organization_id` opsional: bila tidak dikirim dan hanya ada satu organisasi, customer masuk ke organisasi itu. Contoh request dan response lengkap untuk outlet dan order ada di [`mobile-customer-enakpoint.md`](./mobile-customer-enakpoint.md) §4.4–§4.5.
|
|
||||||
|
|
||||||
### GET /customer/wallet
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"point_balance": 12500,
|
|
||||||
"coin_balance": 8,
|
|
||||||
"point_value": 1,
|
|
||||||
"point_discount_value": 12500,
|
|
||||||
"nearest_expiring": {
|
|
||||||
"point": { "amount": 150, "date": "2026-12-31" },
|
|
||||||
"coin": null
|
|
||||||
},
|
|
||||||
"recent_transactions": [ "… sama seperti item riwayat …" ]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
- `point_balance` / `coin_balance` = saldo yang bisa dipakai sekarang.
|
|
||||||
- `point_discount_value` = `point_balance × point_value`; tampilkan sebagai "setara potongan Rp …", bukan saldo uang.
|
|
||||||
- `nearest_expiring.point` / `.coin` bernilai `null` bila tidak ada yang akan kedaluwarsa.
|
|
||||||
|
|
||||||
### GET /customer/wallet/transactions
|
|
||||||
|
|
||||||
| Query | Tipe | Keterangan |
|
|
||||||
| --- | --- | --- |
|
|
||||||
| `page` | int | Default 1 |
|
|
||||||
| `limit` | int | 1–100, default 20 |
|
|
||||||
| `currency` | `POINT` \| `COIN` | Opsional |
|
|
||||||
| `type` | string | Satu tipe atau beberapa dipisah koma, mis. `EARN,TRANSFER_IN` |
|
|
||||||
| `from`, `to` | `YYYY-MM-DD` | Tanggal WIB, inklusif |
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"data": [
|
|
||||||
{
|
|
||||||
"id": "…",
|
|
||||||
"currency": "POINT",
|
|
||||||
"type": "EARN",
|
|
||||||
"amount": 875,
|
|
||||||
"balance_after": 12500,
|
|
||||||
"description": "Belanja #ORD-0123 di Outlet Kemang",
|
|
||||||
"source": { "type": "ORDER", "id": "…" },
|
|
||||||
"outlet_id": "…",
|
|
||||||
"group_id": null,
|
|
||||||
"expires_at": "2026-12-31T23:59:59+07:00",
|
|
||||||
"lots": [{ "amount": 875, "remaining": 875, "expires_at": "2026-12-31T23:59:59+07:00" }],
|
|
||||||
"created_at": "2026-09-30T12:01:00Z"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"pagination": { "page": 1, "limit": 20, "total_count": 42, "total_pages": 3 }
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
`amount` bertanda (+ menambah, − mengurangi). Penambahan membawa `source`, pengurangan membawa `destination`, keduanya `{ type, id }`. Dua baris exchange atau transfer berbagi `group_id`. Daftar tipe ada di bagian Referensi.
|
|
||||||
|
|
||||||
### GET /customer/wallet/expiring
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"point": [
|
|
||||||
{ "amount": 150, "date": "2026-10-31" },
|
|
||||||
{ "amount": 200, "date": "2026-12-31" }
|
|
||||||
],
|
|
||||||
"coin": []
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Terurut dari tanggal terdekat. Daftar kosong berarti tidak ada yang akan kedaluwarsa.
|
|
||||||
|
|
||||||
### PUT /customer/devices
|
|
||||||
|
|
||||||
```json
|
|
||||||
{ "device_id": "a1b2c3", "fcm_token": "…", "platform": "android", "app_version": "2.4.0" }
|
|
||||||
```
|
|
||||||
|
|
||||||
Panggil setelah login dan setiap kali FCM memberi token baru. `device_id` dan `fcm_token` wajib; `platform` = `android` | `ios` | `web`. Satu token hanya milik satu customer: customer lain yang mendaftarkan token yang sama mengambil alih HP itu. Response: `{ "device_id": "a1b2c3" }`.
|
|
||||||
|
|
||||||
## Customer app: PIN
|
|
||||||
|
|
||||||
PIN 6 digit wajib untuk exchange dan transfer; minta customer membuatnya saat pertama kali melakukan aksi itu.
|
|
||||||
|
|
||||||
| Method | Path | Body | Response |
|
|
||||||
| --- | --- | --- | --- |
|
|
||||||
| GET | `/customer/pin/status` | – | `{ "has_pin", "locked_until", "transfer_blocked_until" }` |
|
|
||||||
| POST | `/customer/pin/otp` | `{ "purpose": "pin_setup" }` atau `"pin_reset"` | `{ "purpose", "otp_token", "expires_at" }` |
|
|
||||||
| POST | `/customer/pin` | `{ "otp_token", "otp_code", "pin", "confirm_pin" }` | Status PIN |
|
|
||||||
| PUT | `/customer/pin` | `{ "old_pin", "pin", "confirm_pin" }` | Status PIN |
|
|
||||||
| POST | `/customer/pin/reset` | `{ "otp_token", "otp_code", "pin", "confirm_pin" }` | Status PIN |
|
|
||||||
|
|
||||||
1. **Buat PIN:** minta OTP dengan `purpose: "pin_setup"` (dikirim lewat WhatsApp), lalu `POST /customer/pin` dengan `otp_token` dari response OTP dan kode yang diterima customer.
|
|
||||||
2. **Lupa PIN:** minta OTP dengan `purpose: "pin_reset"`, lalu `POST /customer/pin/reset`. Reset membuka kunci PIN, tapi transfer keluar ditahan 24 jam; exchange tetap bisa.
|
|
||||||
3. **Ganti PIN:** `PUT /customer/pin` dengan PIN lama.
|
|
||||||
|
|
||||||
PIN baru ditolak `304` bila bukan 6 digit, konfirmasinya beda, semua digit sama (`111111`), berurutan (`123456`, `654321`), atau sama dengan tanggal lahir (`DDMMYY` / `YYMMDD`). OTP yang diminta terlalu cepat dijawab `429`. Penanganan `PIN_INVALID`, `PIN_LOCKED`, dan `TRANSFER_BLOCKED` ada di Konvensi umum.
|
|
||||||
|
|
||||||
## Customer app: exchange, transfer, game
|
|
||||||
|
|
||||||
| Method | Path | PIN | Idempotency-Key |
|
|
||||||
| --- | --- | --- | --- |
|
|
||||||
| GET | `/customer/wallet/exchange/preview?coins=` | – | – |
|
|
||||||
| POST | `/customer/wallet/exchange` | Ya | Wajib |
|
|
||||||
| GET | `/customer/wallet/transfer/recipient?phone=` | – | – |
|
|
||||||
| POST | `/customer/wallet/transfer` | Ya | Wajib |
|
|
||||||
| POST | `/customer/enakgame/sessions` | – | Wajib |
|
|
||||||
|
|
||||||
### GET /customer/wallet/exchange/preview?coins=30
|
|
||||||
|
|
||||||
```json
|
|
||||||
{ "coin_amount": 10, "point_amount": 3, "coin_balance": 35, "coins": 30, "points": 9, "valid": true }
|
|
||||||
```
|
|
||||||
|
|
||||||
Kurs: `coin_amount` EnakCoin = `point_amount` EnakPoint (default 1 : 1). Bila `valid: false`, tampilkan `reason`.
|
|
||||||
|
|
||||||
### POST /customer/wallet/exchange
|
|
||||||
|
|
||||||
Body `{ "coins": 30, "pin": "482913" }`. Response:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"group_id": "…",
|
|
||||||
"coins": 30,
|
|
||||||
"points": 9,
|
|
||||||
"coin_amount": 10,
|
|
||||||
"point_amount": 3,
|
|
||||||
"lots": [{ "amount": 9, "expires_at": "2026-12-31T23:59:59+07:00" }],
|
|
||||||
"coin_balance": 5,
|
|
||||||
"point_balance": 9,
|
|
||||||
"replayed": false
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
`coins` harus kelipatan `coin_amount`; jumlah yang salah ditolak `304` sebelum PIN dicek. Exchange tidak bisa dibatalkan. EnakPoint hasil tukar tidak bisa hidup lebih lama dari EnakCoin asalnya (lihat `lots`).
|
|
||||||
|
|
||||||
### GET /customer/wallet/transfer/recipient?phone=081234561234
|
|
||||||
|
|
||||||
```json
|
|
||||||
{ "name": "Bu*** Sa***", "phone_number": "08**-****-1234" }
|
|
||||||
```
|
|
||||||
|
|
||||||
Nomor di luar organisasi atau tidak terdaftar → `404`. Diri sendiri, customer walk-in, atau nonaktif → `304`.
|
|
||||||
|
|
||||||
### POST /customer/wallet/transfer
|
|
||||||
|
|
||||||
Body `{ "currency": "POINT", "amount": 120, "recipient_phone": "081234561234", "pin": "482913" }`. Response:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"group_id": "…",
|
|
||||||
"currency": "POINT",
|
|
||||||
"amount": 120,
|
|
||||||
"recipient": { "name": "Bu*** Sa***", "phone_number": "08**-****-1234" },
|
|
||||||
"lots": [
|
|
||||||
{ "amount": 100, "expires_at": "2026-12-31T23:59:59+07:00" },
|
|
||||||
{ "amount": 20, "expires_at": null }
|
|
||||||
],
|
|
||||||
"balance": 30,
|
|
||||||
"replayed": false
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
`currency` = `POINT` atau `COIN`. Batas organisasi (transfer aktif, minimal, maksimal per transaksi, batas harian per currency yang reset tengah malam WIB) ditolak `304` sebelum PIN dicek. Transfer final. Saldo membawa tanggal kedaluwarsa aslinya ke penerima (`lots`), dan penerima mendapat push `WALLET_TRANSFER_IN`.
|
|
||||||
|
|
||||||
### Game (EnakGame)
|
|
||||||
|
|
||||||
`POST /customer/spin`, `GET /customer/games`, dan `GET /customer/ferris-wheel` sudah dihapus. Semua game, termasuk spin, dimainkan lewat `/customer/enakgame`:
|
|
||||||
|
|
||||||
- `GET /customer/enakgame/games`: game aktif dengan `entry_cost` (EnakCoin per main) dan, untuk spin, `prizes` (segmen roda).
|
|
||||||
- `POST /customer/enakgame/sessions` dengan `{ "game_id": "…" }` dan `Idempotency-Key`: memotong `entry_cost`.
|
|
||||||
- `POST /customer/enakgame/sessions/:id/complete`: server menghitung hadiah EnakCoin; untuk spin, response berisi `prize` (segmen yang keluar).
|
|
||||||
|
|
||||||
Alur spin lengkap ada di [`enakgame-spin.md`](./enakgame-spin.md).
|
|
||||||
|
|
||||||
## POS: earning, void, dan refund
|
|
||||||
|
|
||||||
EnakPoint bukan payment method: tidak ada lagi tipe `point`, dan `POST /payments` memakai `amount` seperti pembayaran lain. Response order membawa `points_earned` dan `coins_earned` untuk struk. Saat order di-void atau direfund, EnakPoint dan EnakCoin yang didapat dari order itu ikut ditarik (`EARN_REVERSAL`); bila saldo sudah terpakai, ditarik sebanyak yang ada dan refund tetap jalan.
|
|
||||||
|
|
||||||
## Dashboard
|
|
||||||
|
|
||||||
Semua endpoint dashboard butuh role Admin atau Manager, dan semuanya dibatasi ke organisasi user yang login. Rincian layar ada di [`backoffice-enakpoint.md`](./backoffice-enakpoint.md).
|
|
||||||
|
|
||||||
| Method | Path | Keterangan |
|
|
||||||
| --- | --- | --- |
|
|
||||||
| GET, PUT | `/outlets/:outlet_id/loyalty-settings` | Earning EnakPoint dan EnakCoin per outlet |
|
|
||||||
| GET, PUT | `/marketing/loyalty-settings` | Nilai EnakPoint, kurs, transfer, kedaluwarsa (`?dry_run=true` untuk preview) |
|
|
||||||
| GET | `/marketing/loyalty-settings/history` | Riwayat perubahan setting (`page`, `limit`, `outlet_id`) |
|
|
||||||
| GET | `/marketing/customers/:id/wallet` | Saldo, lot aktif, riwayat dengan nama asli |
|
|
||||||
| POST | `/marketing/customers/:id/wallet/adjust` | Koreksi saldo manual |
|
|
||||||
| GET | `/marketing/wallet-transactions/:id/trace` | Telusuri asal saldo per butir |
|
|
||||||
| DELETE | `/marketing/customers/:id/pin` | Hapus PIN customer |
|
|
||||||
| GET | `/marketing/customers/:id/security-events` | Log keamanan PIN (`page`, `limit`) |
|
|
||||||
|
|
||||||
Pada kedua `PUT` setting, field yang tidak dikirim tetap memakai nilai sekarang; field yang tidak dikenal ditolak.
|
|
||||||
|
|
||||||
### /outlets/:outlet_id/loyalty-settings
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"point": { "enabled": true, "earn_mode": "PER_AMOUNT", "earn_per_amount": 100, "earn_value": 1, "earn_percent": 1, "min_order_amount": 0, "max_per_order": null },
|
|
||||||
"coin": { "enabled": true, "earn_mode": "PER_AMOUNT", "earn_per_amount": 25000, "earn_value": 1, "earn_percent": 1, "min_order_amount": 0, "max_per_order": null }
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Response menambahkan `outlet_id`, `point_value`, `point_cashback_percent` (default di atas = 1%), dan `changes` pada PUT. `earn_mode` adalah `PER_AMOUNT` (setiap `earn_per_amount` rupiah mendapat `earn_value`) atau `PERCENTAGE` (`earn_percent` persen dari basis). Validasi: `earn_per_amount > 0`, `earn_value ≥ 0`, `earn_percent` 0–100 dengan maks. 2 angka desimal. Objek `point_payment` sudah dihapus; `PUT` yang masih mengirimnya ditolak `310` (field tidak dikenal).
|
|
||||||
|
|
||||||
### /marketing/loyalty-settings
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"point_value": 1,
|
|
||||||
"exchange": { "coin_amount": 1, "point_amount": 1 },
|
|
||||||
"transfer": { "enabled": true, "min_amount": 1, "max_per_transaction": null, "daily_limit": null },
|
|
||||||
"point_expiry": {
|
|
||||||
"enabled": false,
|
|
||||||
"mode": "FIXED_DATE",
|
|
||||||
"fixed_dates": ["12-31"],
|
|
||||||
"grace_months": 3,
|
|
||||||
"period": 12,
|
|
||||||
"unit": "MONTH",
|
|
||||||
"end_of_month": false,
|
|
||||||
"reminder_days": 7
|
|
||||||
},
|
|
||||||
"coin_expiry": { "…": "sama dengan point_expiry" },
|
|
||||||
"enakgame": { "user_daily_limit": 0, "global_daily_limit": 0 }
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
| Field kedaluwarsa | Dipakai mode | Nilai |
|
|
||||||
| --- | --- | --- |
|
|
||||||
| `mode` | – | `FIXED_DATE` (hangus di tanggal tetap tiap tahun) atau `ROLLING` (umur sejak didapat) |
|
|
||||||
| `fixed_dates` | `FIXED_DATE` | `MM-DD`, boleh lebih dari satu; `02-29` ditolak |
|
|
||||||
| `grace_months` | `FIXED_DATE` | 0–24; saldo yang didapat kurang dari ini sebelum tanggal hangus ikut ke tanggal berikutnya |
|
|
||||||
| `period`, `unit` | `ROLLING` | ≥ 1, `DAY` atau `MONTH` |
|
|
||||||
| `end_of_month` | `ROLLING` | Dibulatkan ke akhir bulan |
|
|
||||||
| `reminder_days` | keduanya | Hari sebelum hangus untuk pengingat; 0 = tanpa pengingat |
|
|
||||||
|
|
||||||
Response menambahkan:
|
|
||||||
|
|
||||||
- `impact`: saldo beredar dan nilai rupiahnya sebelum/sesudah perubahan `point_value` atau kurs.
|
|
||||||
- `expiry_preview`: `{ "point", "coin" }`, kapan saldo yang didapat sekarang kedaluwarsa (`null` = tidak).
|
|
||||||
- `expiry_activations`: bila perubahan ini menyalakan kedaluwarsa pertama kali, `[{ "currency", "lots", "amount", "expires_at" }]` saldo lama yang ikut diberi tanggal.
|
|
||||||
- `changes` dan `dry_run`.
|
|
||||||
|
|
||||||
### POST /marketing/customers/:id/wallet/adjust
|
|
||||||
|
|
||||||
```json
|
|
||||||
{ "currency": "POINT", "amount": -500, "reason": "Komplain #45", "idempotency_key": "adj-45" }
|
|
||||||
```
|
|
||||||
|
|
||||||
`amount` bertanda dan tidak boleh 0; `reason` wajib. Pengurangan yang melebihi saldo ditolak `304`. Response: `{ "transaction", "spendable_point_balance", "spendable_coin_balance", "replayed" }`.
|
|
||||||
|
|
||||||
### GET /marketing/wallet-transactions/:id/trace
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"transaction": { "id": "…", "customer": { "id": "…", "name": "Budi Santoso" }, "type": "TRANSFER_OUT", "amount": -30, "…": "…" },
|
|
||||||
"lots": [
|
|
||||||
{
|
|
||||||
"amount": 30,
|
|
||||||
"chain": [
|
|
||||||
{ "lot": { "id": "…", "expires_at": "…" }, "source": { "type": "TRANSFER_IN", "customer": { "name": "Budi Santoso" } } },
|
|
||||||
{ "lot": { "id": "…", "origin_lot_id": null }, "source": { "type": "EARN", "reference_type": "ORDER", "description": "Belanja #ORD-1", "customer": { "name": "Anita" } } }
|
|
||||||
]
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Pengurangan menampilkan lot yang dipakai; penambahan menampilkan lot yang dibuat. Tiap `chain` mundur lewat transfer atau exchange sampai lot pertama dari `EARN`, `ADJUSTMENT`, atau `MIGRATION`.
|
|
||||||
|
|
||||||
### PIN customer
|
|
||||||
|
|
||||||
`DELETE /marketing/customers/:id/pin` dengan `{ "reason": "…" }` memaksa customer membuat PIN baru lewat OTP; admin tidak bisa membuat, mengganti, atau melihat PIN. `security-events` mengembalikan `PIN_SET`, `PIN_CHANGED`, `PIN_RESET`, `PIN_FAILED`, `PIN_LOCKED`, `PIN_REMOVED_BY_ADMIN` beserta waktu, IP, dan perangkat.
|
|
||||||
|
|
||||||
## Referensi
|
|
||||||
|
|
||||||
### Tipe mutasi (`type`)
|
|
||||||
|
|
||||||
| `type` | Arah | Arti | `source` / `destination` |
|
|
||||||
| --- | --- | --- | --- |
|
|
||||||
| `EARN` | + | Didapat dari order lunas | `ORDER` |
|
|
||||||
| `EARN_REVERSAL` | − | Ditarik karena order di-void/refund | `ORDER` |
|
|
||||||
| `EXCHANGE_OUT` | − | EnakCoin ditukar | `WALLET_TX` (baris `EXCHANGE_IN`) |
|
|
||||||
| `EXCHANGE_IN` | + | EnakPoint hasil tukar | `WALLET_TX` (baris `EXCHANGE_OUT`) |
|
|
||||||
| `TRANSFER_OUT` | − | Dikirim ke customer lain | `WALLET_TX` (baris `TRANSFER_IN`) |
|
|
||||||
| `TRANSFER_IN` | + | Diterima dari customer lain | `WALLET_TX` (baris `TRANSFER_OUT`) |
|
|
||||||
| `GAME_SPEND` | − | Main game (EnakCoin saja) | `GAME_PLAY` |
|
|
||||||
| `EXPIRE` | − | Hangus karena kedaluwarsa | `LOT` |
|
|
||||||
| `ADJUSTMENT` | + / − | Koreksi admin | `USER` |
|
|
||||||
| `MIGRATION` | + | Saldo dari sistem lama | `LEGACY_POINTS` / `LEGACY_TOKENS` |
|
|
||||||
|
|
||||||
### Notifikasi push (FCM)
|
|
||||||
|
|
||||||
Semua nilai `data` berupa string. Push hanya sampai ke device yang terdaftar lewat `PUT /customer/devices`.
|
|
||||||
|
|
||||||
| `data.type` | Kapan | Isi `data` lainnya |
|
|
||||||
| --- | --- | --- |
|
|
||||||
| `WALLET_TRANSFER_IN` | Menerima transfer | `transaction_id`, `group_id`, `currency`, `amount` |
|
|
||||||
| `WALLET_EXPIRING` | `reminder_days` hari sebelum hangus, sekali per tanggal | `currency`, `amount`, `expiry_date` |
|
|
||||||
| `WALLET_EXPIRED` | Saldo baru saja hangus | `currency`, `amount` |
|
|
||||||
| `PIN_LOCKED` | PIN terkunci setelah 5 kali salah | `locked_until` (RFC3339, UTC) |
|
|
||||||
|
|
||||||
### Endpoint dan field deprecated
|
|
||||||
|
|
||||||
Masih jalan dan membaca wallet, tapi akan dihapus setelah semua versi aplikasi pindah. Semua yang bernama token (`/customer/tokens`, `total_tokens`, `tokens_history`, `token_used`, `tokens_remaining`, campaign `TOKENS`) sudah dihapus; pakai `coin_balance`, `coins_used`, `coins_remaining`, dan `COINS`.
|
|
||||||
|
|
||||||
| Lama | Pengganti |
|
|
||||||
| --- | --- |
|
|
||||||
| `GET /customer/points` | `GET /customer/wallet` → `point_balance` |
|
|
||||||
| `total_points`, `points_history`, `last_updated` di `/customer/wallet` | `point_balance`, `recent_transactions` |
|
|
||||||
|
|
||||||
### Endpoint dan field yang dihapus
|
|
||||||
|
|
||||||
Bayar dengan EnakPoint dihapus pada 7 Okt 2026 karena EnakPoint sekarang hanya untuk voucher ([`enakgame-prd.md`](./enakgame-prd.md) §3.2). Tidak ada penggantinya; jangan dipanggil lagi.
|
|
||||||
|
|
||||||
| Dihapus | Catatan |
|
|
||||||
| --- | --- |
|
|
||||||
| `POST /customer/wallet/payment-code` | Kode bayar untuk kasir |
|
|
||||||
| `POST /customer/orders/:id/pay-with-points` | Bayar order dari app / self-order |
|
|
||||||
| `GET /orders/:id/point-payment/preview` | Batas pembayaran EnakPoint di POS |
|
|
||||||
| Payment method tipe `point`; field `points` dan `payment_code` di `POST /payments` | `amount` kembali wajib seperti pembayaran lain |
|
|
||||||
| `points_used`, `point_value` di response pembayaran dan di `payments` pada `GET /customer/orders/:id` | – |
|
|
||||||
| `accepts_point_payment` di `GET /customer/outlets` | – |
|
|
||||||
| `point_payment` (`accept_payment`, `min_payment_points`, `max_payment_percent`) di `/outlets/:outlet_id/loyalty-settings` | `PUT` yang masih mengirimnya ditolak `310` |
|
|
||||||
| `summary.point_amount`, `summary.points_used`, `summary.total_with_points`, serta `points_used` dan `counts_as_cash_in` per baris di analytics payment method | `summary.total_amount` kembali total semua method; persentase dihitung dari total itu |
|
|
||||||
| Tipe mutasi `PAYMENT` dan `PAYMENT_REFUND` | Tidak ditulis lagi |
|
|
||||||
|
|
||||||
Panduan alur lengkap per tim ada di [`integration-enakpoint.md`](./integration-enakpoint.md).
|
|
||||||
@@ -1,299 +0,0 @@
|
|||||||
# Backoffice EnakPoint & EnakCoin
|
|
||||||
|
|
||||||
30 Sep 2026
|
|
||||||
|
|
||||||
Backoffice perlu tujuh layar untuk mengelola program loyalitas: setting per outlet, setting per organisasi (termasuk kedaluwarsa), wallet customer, telusuri mutasi, PIN customer, riwayat setting, dan biaya main game.
|
|
||||||
|
|
||||||
> **Perubahan 7 Okt 2026:** bayar dengan EnakPoint sudah dihapus karena EnakPoint sekarang hanya bisa ditukar ke voucher, tidak bisa dipakai sebagai alat bayar dan tidak bisa dicairkan ([`enakgame-prd.md`](./enakgame-prd.md) §3.2). Akibatnya setting outlet tidak lagi punya `point_payment`, method "EnakPoint" (tipe `point`) tidak ada lagi di Payment Method, dan laporan per payment method tidak lagi membawa `point_amount`, `points_used`, `total_with_points`, atau `counts_as_cash_in`; `summary.total_amount` kembali total semua method.
|
|
||||||
|
|
||||||
## Layar yang perlu dibuat
|
|
||||||
|
|
||||||
Semua endpoint di bawah base URL `/api/v1`, butuh login user dengan role Admin atau Manager, dan otomatis dibatasi ke organisasi user tersebut. Data customer atau outlet organisasi lain dijawab `404`.
|
|
||||||
|
|
||||||
| Layar | Endpoint | Tempat di menu |
|
|
||||||
| --- | --- | --- |
|
|
||||||
| Setting loyalitas outlet | `GET` / `PUT /outlets/:outlet_id/loyalty-settings` | Outlet → detail outlet → tab Loyalitas |
|
|
||||||
| Setting loyalitas organisasi | `GET` / `PUT /marketing/loyalty-settings` (+ `?dry_run=true`) | Marketing → Loyalitas → Pengaturan |
|
|
||||||
| Riwayat perubahan setting | `GET /marketing/loyalty-settings/history` | Marketing → Loyalitas → Riwayat |
|
|
||||||
| Wallet customer | `GET /marketing/customers/:id/wallet`, `POST …/wallet/adjust` | Customer → detail customer → tab Wallet |
|
|
||||||
| Telusuri mutasi | `GET /marketing/wallet-transactions/:id/trace` | Dibuka dari baris riwayat wallet |
|
|
||||||
| PIN & keamanan customer | `DELETE /marketing/customers/:id/pin`, `GET …/security-events` | Customer → detail customer → tab Keamanan |
|
|
||||||
| Biaya main game | `entry_cost` di `/marketing/enakgame/games` | Marketing → EnakGame → game |
|
|
||||||
|
|
||||||
Penempatan menu di atas adalah usulan; sesuaikan dengan struktur backoffice yang ada.
|
|
||||||
|
|
||||||
**Istilah di layar.** EnakPoint (`POINT`) adalah saldo yang hanya bisa ditukar ke voucher, bukan alat bayar; EnakCoin (`COIN`) untuk main game dan bisa ditukar ke EnakPoint. Nilai rupiah EnakPoint selalu ditulis "setara potongan Rp …", tidak pernah "saldo Rp …", karena saldo tidak bisa dicairkan.
|
|
||||||
|
|
||||||
**Format response.** Sukses `{ "success": true, "data": … }`; gagal `{ "success": false, "errors": [{ "code", "entity", "cause" }] }`. Tampilkan `cause` sebagai pesan (lihat bagian Pesan error).
|
|
||||||
|
|
||||||
## Setting loyalitas outlet
|
|
||||||
|
|
||||||
Tiap outlet mengatur sendiri berapa EnakPoint dan EnakCoin yang didapat dari order. Semua nilai default mati sampai owner menyalakannya.
|
|
||||||
|
|
||||||
`GET /outlets/:outlet_id/loyalty-settings` → isi form. `PUT` ke path yang sama dengan objek yang sama untuk menyimpan; field yang tidak dikirim tetap, field tak dikenal ditolak (termasuk `point_payment` yang sudah dihapus).
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"point": { "enabled": true, "earn_mode": "PER_AMOUNT", "earn_per_amount": 100, "earn_value": 1, "earn_percent": 1, "min_order_amount": 0, "max_per_order": null },
|
|
||||||
"coin": { "enabled": true, "earn_mode": "PER_AMOUNT", "earn_per_amount": 25000, "earn_value": 1, "earn_percent": 1, "min_order_amount": 0, "max_per_order": null }
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
| Field | Label usulan | Tipe | Default | Validasi |
|
|
||||||
| --- | --- | --- | --- | --- |
|
|
||||||
| `point.enabled` / `coin.enabled` | Beri EnakPoint / EnakCoin | toggle | mati | – |
|
|
||||||
| `earn_mode` | Cara hitung: per nominal / persentase | pilihan `PER_AMOUNT` / `PERCENTAGE` | `PER_AMOUNT` | salah satu dari keduanya |
|
|
||||||
| `earn_per_amount` | Setiap belanja Rp … (mode `PER_AMOUNT`) | Rp | 100 (point), 25.000 (coin) | > 0 |
|
|
||||||
| `earn_value` | … mendapat (mode `PER_AMOUNT`) | angka | 1 | ≥ 0 |
|
|
||||||
| `earn_percent` | … % dari belanja (mode `PERCENTAGE`) | %, boleh desimal | 1 | 0–100, maks. 2 angka desimal |
|
|
||||||
| `min_order_amount` | Minimal belanja | Rp | 0 | ≥ 0 |
|
|
||||||
| `max_per_order` | Maksimal per order | angka, boleh kosong | kosong = tanpa batas | ≥ 0 |
|
|
||||||
|
|
||||||
**Cashback efektif.** Response membawa `point_cashback_percent` dan `point_value`. Tampilkan persentase di samping field earning EnakPoint, mis. "setara cashback 1%", dan hitung ulang di sisi klien saat owner mengetik: `earn_value × point_value ÷ earn_per_amount × 100`, atau pada mode `PERCENTAGE`: `earn_percent × point_value`. Tujuannya agar owner tidak salah membaca skala (1 per Rp 100 bukan 1 per Rp 1).
|
|
||||||
|
|
||||||
**Mode earning.** Tampilkan hanya field mode yang dipilih (`earn_per_amount` + `earn_value`, atau `earn_percent`). Field mode lain tetap tersimpan di server, jadi tidak perlu dikosongkan saat owner berpindah mode. Pada mode `PERCENTAGE` jumlah yang didapat adalah `floor(basis × earn_percent ÷ 100)`, mis. 2,5% dari Rp 87.500 = 2.187 EnakPoint.
|
|
||||||
|
|
||||||
**Contoh di bawah form.** "Belanja Rp 87.500 mendapat 875 EnakPoint dan 3 EnakCoin." Earning dihitung dari subtotal setelah diskon, sebelum pajak.
|
|
||||||
|
|
||||||
Setelah `PUT`, response membawa `changes` (key yang berubah); tampilkan toast singkat, mis. "2 pengaturan disimpan".
|
|
||||||
|
|
||||||
## Setting loyalitas organisasi
|
|
||||||
|
|
||||||
Nilai rupiah EnakPoint, kurs exchange, batas transfer, dan kedaluwarsa berlaku sama untuk semua outlet, jadi diatur sekali per organisasi. Mengubah nilai EnakPoint atau kurs langsung mengubah daya beli semua saldo customer, jadi layar ini wajib menampilkan dampaknya sebelum disimpan.
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"point_value": 1,
|
|
||||||
"exchange": { "coin_amount": 1, "point_amount": 1 },
|
|
||||||
"transfer": { "enabled": true, "min_amount": 1, "max_per_transaction": null, "daily_limit": null },
|
|
||||||
"point_expiry": { "…": "lihat bagian kedaluwarsa" },
|
|
||||||
"coin_expiry": { "…": "lihat bagian kedaluwarsa" },
|
|
||||||
"enakgame": { "user_daily_limit": 0, "global_daily_limit": 0 }
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
| Field | Label usulan | Default | Validasi |
|
|
||||||
| --- | --- | --- | --- |
|
|
||||||
| `point_value` | Nilai 1 EnakPoint (Rp) | 1 | ≥ 1 |
|
|
||||||
| `exchange.coin_amount` : `exchange.point_amount` | Kurs tukar: … EnakCoin = … EnakPoint | 1 : 1 | keduanya ≥ 1 |
|
|
||||||
| `transfer.enabled` | Izinkan transfer antar customer | aktif | – |
|
|
||||||
| `transfer.min_amount` | Minimal per transfer | 1 | ≥ 1 |
|
|
||||||
| `transfer.max_per_transaction` | Maksimal per transfer | kosong = tanpa batas | ≥ 1 |
|
|
||||||
| `transfer.daily_limit` | Batas harian per customer | kosong = tanpa batas | ≥ 1, dihitung per currency, reset tengah malam WIB |
|
|
||||||
| `enakgame.user_daily_limit` | Maksimal EnakCoin dari EnakGame per customer per hari | 0 = tanpa batas | ≥ 0, reset tengah malam WIB |
|
|
||||||
| `enakgame.global_daily_limit` | Maksimal EnakCoin dari EnakGame seluruh organisasi per hari | 0 = tanpa batas | ≥ 0, reset tengah malam WIB |
|
|
||||||
|
|
||||||
### Alur simpan
|
|
||||||
|
|
||||||
1. Owner mengubah form.
|
|
||||||
2. Tombol Simpan memanggil `PUT /marketing/loyalty-settings?dry_run=true` dengan objek yang diubah. Tidak ada yang tersimpan.
|
|
||||||
3. Bila `changes` kosong, beri tahu "tidak ada perubahan" dan berhenti.
|
|
||||||
4. Tampilkan dialog konfirmasi berisi `changes`, `impact` (bila `point_value` atau kurs berubah), dan `expiry_activations` (bila ada, lihat bagian kedaluwarsa).
|
|
||||||
5. Konfirmasi memanggil `PUT` yang sama tanpa `dry_run`.
|
|
||||||
|
|
||||||
### Dialog dampak
|
|
||||||
|
|
||||||
`impact` berisi saldo beredar organisasi dan nilainya sebelum/sesudah:
|
|
||||||
|
|
||||||
| Field `impact` | Tampilkan sebagai |
|
|
||||||
| --- | --- |
|
|
||||||
| `outstanding_points` | EnakPoint beredar |
|
|
||||||
| `point_rupiah_before` → `point_rupiah_after` | Setara potongan Rp … → Rp … |
|
|
||||||
| `outstanding_coins` | EnakCoin beredar |
|
|
||||||
| `coins_as_points_before` → `coins_as_points_after` | Bila semua ditukar: … EnakPoint → … EnakPoint |
|
|
||||||
| `coin_rupiah_before` → `coin_rupiah_after` | Setara potongan Rp … → Rp … |
|
|
||||||
|
|
||||||
Contoh kalimat: "Menaikkan nilai EnakPoint dari Rp 1 ke Rp 2 membuat 1.250.000 EnakPoint yang beredar setara potongan Rp 2.500.000 (sebelumnya Rp 1.250.000)." Perubahan hanya berlaku ke depan: exchange yang sudah terjadi memakai kurs saat itu.
|
|
||||||
|
|
||||||
## Pengaturan kedaluwarsa
|
|
||||||
|
|
||||||
Kedaluwarsa diatur terpisah untuk EnakPoint (`point_expiry`) dan EnakCoin (`coin_expiry`) dengan salah satu dari dua model; defaultnya mati, dan bila dinyalakan defaultnya hangus setiap 31 Desember.
|
|
||||||
|
|
||||||
```json
|
|
||||||
"point_expiry": {
|
|
||||||
"enabled": true,
|
|
||||||
"mode": "FIXED_DATE",
|
|
||||||
"fixed_dates": ["12-31"],
|
|
||||||
"grace_months": 3,
|
|
||||||
"period": 12,
|
|
||||||
"unit": "MONTH",
|
|
||||||
"end_of_month": false,
|
|
||||||
"reminder_days": 7
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
| Field | Tampil saat | Label usulan | Validasi |
|
|
||||||
| --- | --- | --- | --- |
|
|
||||||
| `enabled` | selalu | Saldo bisa kedaluwarsa | – |
|
|
||||||
| `mode` | aktif | Model: Tanggal tetap / Sejak didapat | `FIXED_DATE` atau `ROLLING` |
|
|
||||||
| `fixed_dates` | `FIXED_DATE` | Tanggal hangus setiap tahun | minimal satu, format `MM-DD`, `02-29` ditolak |
|
|
||||||
| `grace_months` | `FIXED_DATE` | Periode tanggung (bulan) | 0–24, default 3 |
|
|
||||||
| `period` + `unit` | `ROLLING` | Berlaku selama … hari/bulan | period ≥ 1, `DAY` atau `MONTH` |
|
|
||||||
| `end_of_month` | `ROLLING` | Bulatkan ke akhir bulan | – |
|
|
||||||
| `reminder_days` | aktif | Ingatkan customer … hari sebelumnya | ≥ 0, 0 = tanpa pengingat |
|
|
||||||
|
|
||||||
**Tanggal tetap (`FIXED_DATE`).** Semua saldo hangus di tanggal yang sama, mis. 31 Desember, atau 30 Juni dan 31 Desember untuk dua kali setahun. Saldo yang didapat kurang dari `grace_months` sebelum tanggal itu ikut ke tanggal berikutnya, jadi saldo yang didapat 1 Oktober dengan tanggung 3 bulan hangus 31 Desember tahun depan. Untuk input `fixed_dates`, pakai pemilih tanggal+bulan tanpa tahun.
|
|
||||||
|
|
||||||
**Sejak didapat (`ROLLING`).** Tiap saldo berlaku `period` hari atau bulan sejak masuk, mis. 12 bulan. Dengan `end_of_month`, saldo yang didapat 14 Maret 2026 hangus 31 Maret 2027.
|
|
||||||
|
|
||||||
**Preview.** Response `GET`, `PUT`, dan dry run membawa `expiry_preview.point` dan `.coin`: kapan saldo yang didapat sekarang akan kedaluwarsa (`null` = tidak). Tampilkan di bawah form: "EnakPoint yang didapat hari ini kedaluwarsa pada 31 Des 2026." Karena dihitung dari nilai yang dikirim, dry run bisa dipakai untuk memperbarui preview saat owner mengubah pilihan.
|
|
||||||
|
|
||||||
**Menyalakan pertama kali.** Saldo lama yang belum punya tanggal ikut diberi tanggal, dengan masa berlaku penuh: tanggal hangus kedua berikutnya (`FIXED_DATE`) atau satu periode sejak hari ini (`ROLLING`). Dry run mengembalikan `expiry_activations`; tampilkan di dialog konfirmasi dengan kalimat tegas, mis. "1.250.000 EnakPoint milik customer yang ada sekarang akan kedaluwarsa pada 31 Des 2027. Tindakan ini tidak bisa dibatalkan dengan mematikan kedaluwarsa."
|
|
||||||
|
|
||||||
| Field `expiry_activations[]` | Arti |
|
|
||||||
| --- | --- |
|
|
||||||
| `currency` | `POINT` atau `COIN` |
|
|
||||||
| `lots` | Jumlah paket saldo yang diberi tanggal |
|
|
||||||
| `amount` | Total saldo yang diberi tanggal |
|
|
||||||
| `expires_at` | Tanggal kedaluwarsanya |
|
|
||||||
|
|
||||||
**Aturan lain yang perlu dijelaskan di layar:**
|
|
||||||
|
|
||||||
- Mengubah model atau masa berlaku hanya berlaku untuk saldo yang masuk setelahnya.
|
|
||||||
- Mematikan kedaluwarsa tidak membatalkan tanggal yang sudah terjadwal.
|
|
||||||
- Saldo yang ditransfer atau ditukar membawa tanggal kedaluwarsa aslinya.
|
|
||||||
- Saldo hangus tanpa kompensasi apa pun. Customer mendapat pengingat push `reminder_days` hari sebelumnya dan notifikasi saat hangus.
|
|
||||||
|
|
||||||
## Wallet customer
|
|
||||||
|
|
||||||
Tab Wallet di detail customer dipakai untuk menangani komplain: melihat saldo dan asal-usulnya, mengoreksi saldo, dan menelusuri satu mutasi sampai ke order asalnya.
|
|
||||||
|
|
||||||
### Saldo, lot, dan riwayat
|
|
||||||
|
|
||||||
`GET /marketing/customers/:id/wallet?page=1&limit=20¤cy=POINT&type=TRANSFER_OUT,EARN&from=2026-09-01&to=2026-09-30` (semua query opsional, sama seperti riwayat di aplikasi customer)
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"customer": { "id": "…", "name": "Budi Santoso", "phone": "081234561234" },
|
|
||||||
"point_balance": 12650,
|
|
||||||
"coin_balance": 8,
|
|
||||||
"spendable_point_balance": 12500,
|
|
||||||
"spendable_coin_balance": 8,
|
|
||||||
"lots": [
|
|
||||||
{ "id": "…", "currency": "POINT", "original_amount": 875, "remaining_amount": 875, "expires_at": "2026-12-31T23:59:59+07:00", "expired": false, "source_transaction_id": "…", "origin_lot_id": null, "created_at": "…" }
|
|
||||||
],
|
|
||||||
"transactions": {
|
|
||||||
"data": [
|
|
||||||
{
|
|
||||||
"id": "…", "currency": "POINT", "type": "TRANSFER_OUT", "amount": -120, "balance_after": 12650,
|
|
||||||
"description": "Transfer ke An*** (08**-****-5678)",
|
|
||||||
"destination": { "type": "WALLET_TX", "id": "…" },
|
|
||||||
"counterparty": { "id": "…", "name": "Anita Rahma" },
|
|
||||||
"created_by": null, "outlet": null, "reason": null, "metadata": {},
|
|
||||||
"created_at": "…"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"pagination": { "page": 1, "limit": 20, "total_count": 42, "total_pages": 3 }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
- **Saldo:** tampilkan `spendable_*` sebagai saldo utama. `point_balance` / `coin_balance` bisa sedikit lebih besar selama ada lot yang sudah lewat tanggal tapi belum diproses job kedaluwarsa (paling lama sekitar 15 menit).
|
|
||||||
- **Lot:** tabel paket saldo yang masih berisi, urut dari yang paling cepat kedaluwarsa. Beri tanda untuk `expired: true`.
|
|
||||||
- **Riwayat:** sama dengan riwayat customer, ditambah nama asli yang disamarkan untuk customer: `counterparty` (lawan transfer), `created_by` (admin pelaku adjustment), `outlet`, `reason`, dan `metadata` (kurs, rumus earning, shortfall).
|
|
||||||
|
|
||||||
### Adjustment manual
|
|
||||||
|
|
||||||
`POST /marketing/customers/:id/wallet/adjust`
|
|
||||||
|
|
||||||
```json
|
|
||||||
{ "currency": "POINT", "amount": -500, "reason": "Komplain #45", "idempotency_key": "adj-7f3c" }
|
|
||||||
```
|
|
||||||
|
|
||||||
| Field | Aturan |
|
|
||||||
| --- | --- |
|
|
||||||
| `currency` | `POINT` atau `COIN` |
|
|
||||||
| `amount` | Bertanda, tidak boleh 0. Positif menambah, negatif mengurangi |
|
|
||||||
| `reason` | Wajib; tampil di riwayat customer sebagai "Koreksi oleh admin: …" |
|
|
||||||
| `idempotency_key` | Opsional tapi disarankan: buat satu nilai saat dialog dibuka, supaya klik ganda tidak mengoreksi dua kali |
|
|
||||||
|
|
||||||
Pengurangan yang melebihi saldo yang bisa dipakai ditolak `304`. Adjustment tambah mengikuti aturan kedaluwarsa organisasi. Response: `{ "transaction", "spendable_point_balance", "spendable_coin_balance", "replayed" }`. Beri catatan di dialog bahwa adjustment tidak disertai pembayaran uang, sehingga alasan tidak boleh "pencairan".
|
|
||||||
|
|
||||||
### Telusuri mutasi
|
|
||||||
|
|
||||||
Dari baris riwayat mana pun, tombol Telusuri memanggil `GET /marketing/wallet-transactions/:id/trace`.
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"transaction": { "id": "…", "customer": { "id": "…", "name": "Budi Santoso" }, "currency": "POINT", "type": "TRANSFER_OUT", "amount": -30, "description": "Transfer ke Ri*** (08**-****-9012)", "reference_type": "WALLET_TX", "reference_id": "…", "created_at": "…" },
|
|
||||||
"lots": [
|
|
||||||
{
|
|
||||||
"amount": 30,
|
|
||||||
"chain": [
|
|
||||||
{ "lot": { "id": "…", "expires_at": "…", "origin_lot_id": "…" }, "source": { "type": "TRANSFER_IN", "customer": { "name": "Budi Santoso" }, "description": "Transfer dari An*** (08**-****-5678)" } },
|
|
||||||
{ "lot": { "id": "…", "origin_lot_id": null }, "source": { "type": "EARN", "customer": { "name": "Anita Rahma" }, "reference_type": "ORDER", "reference_id": "…", "description": "Belanja #ORD-1 di Outlet Kemang" } }
|
|
||||||
]
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Tampilkan tiap `lots[]` sebagai rantai dari atas ke bawah: jumlah yang lewat lot itu, lalu setiap langkah `chain` dengan pemilik, tipe, dan deskripsinya. Langkah terakhir selalu `EARN`, `ADJUSTMENT`, atau `MIGRATION`; bila `reference_type` = `ORDER`, jadikan tautan ke detail order. Mutasi keluar menampilkan lot yang dipakai; mutasi masuk menampilkan lot yang dibuatnya.
|
|
||||||
|
|
||||||
## PIN, riwayat setting, dan game
|
|
||||||
|
|
||||||
### PIN & keamanan customer
|
|
||||||
|
|
||||||
Admin tidak bisa membuat, mengganti, atau melihat PIN customer; satu-satunya aksi adalah menghapusnya, misalnya bila customer kehilangan akses, sehingga customer harus membuat PIN baru lewat OTP di aplikasi.
|
|
||||||
|
|
||||||
- `DELETE /marketing/customers/:id/pin` dengan body `{ "reason": "Customer ganti nomor HP" }`. `reason` wajib. Tampilkan dialog konfirmasi dengan input alasan.
|
|
||||||
- `GET /marketing/customers/:id/security-events?page=1&limit=20` untuk tab Keamanan:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"data": [
|
|
||||||
{ "id": "…", "event": "PIN_LOCKED", "actor_user": null, "reason": null, "ip_address": "103.10.0.7", "user_agent": "EnakApp/2.4 (Android 14)", "created_at": "…" }
|
|
||||||
],
|
|
||||||
"pagination": { "page": 1, "limit": 20, "total_count": 5, "total_pages": 1 }
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
| `event` | Label usulan |
|
|
||||||
| --- | --- |
|
|
||||||
| `PIN_SET` | PIN dibuat |
|
|
||||||
| `PIN_CHANGED` | PIN diganti |
|
|
||||||
| `PIN_RESET` | PIN direset lewat OTP (transfer ditahan 24 jam) |
|
|
||||||
| `PIN_FAILED` | PIN salah dimasukkan |
|
|
||||||
| `PIN_LOCKED` | PIN terkunci 30 menit |
|
|
||||||
| `PIN_REMOVED_BY_ADMIN` | PIN dihapus admin (`actor_user`, `reason` terisi) |
|
|
||||||
|
|
||||||
### Riwayat perubahan setting
|
|
||||||
|
|
||||||
`GET /marketing/loyalty-settings/history?page=1&limit=20` untuk setting organisasi; tambah `&outlet_id=…` untuk riwayat satu outlet.
|
|
||||||
|
|
||||||
```json
|
|
||||||
{ "id": "…", "organization_id": "…", "outlet_id": null, "key": "loyalty.point.value", "old_value": "1", "new_value": "2", "changed_by": "…", "created_at": "…" }
|
|
||||||
```
|
|
||||||
|
|
||||||
`old_value` `null` berarti sebelumnya masih nilai default. Tampilkan `key` dengan label yang sama seperti di form (mis. `loyalty.point.value` → "Nilai 1 EnakPoint"), dan `changed_by` sebagai nama user.
|
|
||||||
|
|
||||||
### Biaya main game
|
|
||||||
|
|
||||||
Semua game (spin, raffle, minigame) memakai EnakCoin yang sama dan dikelola di `/marketing/enakgame/games`. Menu lama `/marketing/games`, `/marketing/game-prizes`, dan `/marketing/rewards` sudah dihapus. Biaya per main adalah `entry_cost` game (bilangan bulat ≥ 1), hadiahnya diatur di reward config game itu. Langkah membuat spin ada di [`enakgame-spin.md`](./enakgame-spin.md). Hadiah game juga bernilai rupiah secara tidak langsung, karena EnakCoin bisa ditukar ke EnakPoint.
|
|
||||||
|
|
||||||
## Pesan error dan checklist
|
|
||||||
|
|
||||||
| `code` | HTTP | Kapan terjadi di backoffice | Yang ditampilkan |
|
|
||||||
| --- | --- | --- | --- |
|
|
||||||
| `303`, `310` | 400 | Body tidak valid, field tak dikenal di `PUT` setting, UUID salah | Pesan umum "Data tidak valid" + `cause` untuk developer |
|
|
||||||
| `304` | 400 | Nilai di luar batas, adjustment melebihi saldo, alasan kosong | `cause` di dekat field atau di toast |
|
|
||||||
| `404` | 404 | Customer, outlet, atau mutasi bukan milik organisasi ini | "Data tidak ditemukan" |
|
|
||||||
| `900` | 500 | Kesalahan server | "Terjadi kesalahan, coba lagi" |
|
|
||||||
|
|
||||||
Pesan `cause` saat ini berbahasa Inggris, mis. `invalid loyalty settings: loyalty.point.earn_per_amount must be at least 1`. Untuk validasi form, lebih baik cek batasnya di sisi klien (tabel di tiap bagian) dan tampilkan `cause` hanya sebagai cadangan.
|
|
||||||
|
|
||||||
### Checklist rilis
|
|
||||||
|
|
||||||
- [ ] Form setting outlet menampilkan cashback efektif dan contoh earning.
|
|
||||||
- [ ] Setting organisasi selalu lewat dry run dan dialog konfirmasi sebelum disimpan.
|
|
||||||
- [ ] Dialog konfirmasi menampilkan `impact` saat nilai EnakPoint atau kurs berubah.
|
|
||||||
- [ ] Dialog konfirmasi menampilkan `expiry_activations` saat kedaluwarsa dinyalakan pertama kali.
|
|
||||||
- [ ] Preview "yang didapat hari ini kedaluwarsa pada …" tampil di bawah pengaturan kedaluwarsa.
|
|
||||||
- [ ] Wallet customer menampilkan saldo yang bisa dipakai, lot, dan riwayat dengan nama asli.
|
|
||||||
- [ ] Adjustment mewajibkan alasan dan mengirim `idempotency_key`.
|
|
||||||
- [ ] Tombol Telusuri ada di setiap baris riwayat.
|
|
||||||
- [ ] Hapus PIN mewajibkan alasan; tab Keamanan menampilkan log.
|
|
||||||
- [ ] Form game EnakGame punya input `entry_cost`.
|
|
||||||
- [ ] Semua nilai rupiah EnakPoint ditulis "setara potongan Rp …".
|
|
||||||
|
|
||||||
Transfer belum boleh dirilis sebelum tinjauan legal (N3) selesai. Layar backoffice boleh disiapkan lebih dulu.
|
|
||||||
@@ -1,86 +0,0 @@
|
|||||||
# Spin sebagai Game EnakGame
|
|
||||||
|
|
||||||
**Sumber:** [RFC EnakGame](rfc-enakgame.md) §14, task EG-1001
|
|
||||||
**Pembaca:** admin organisasi dan tim backoffice / aplikasi customer
|
|
||||||
|
|
||||||
Spin lama (`POST /customer/spin`) diganti dengan game EnakGame biasa: tipe `SPIN`,
|
|
||||||
reward `PROBABILITY`, hadiah berupa EnakCoin. Spin dimainkan lewat endpoint session
|
|
||||||
yang sama dengan game lain, sehingga ikut mendapat idempotency, refund otomatis, budget,
|
|
||||||
event, dan Economy Guard.
|
|
||||||
|
|
||||||
Tidak ada seeder: setiap organisasi membuat spin-nya sendiri lewat API admin di bawah.
|
|
||||||
Semua langkah memakai token admin organisasi; langkah 2–4 butuh loyalty manager.
|
|
||||||
|
|
||||||
## Langkah Admin
|
|
||||||
|
|
||||||
### 1. Buat game
|
|
||||||
|
|
||||||
`POST /api/v1/marketing/enakgame/games`
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"name": "Spin Harian",
|
|
||||||
"slug": "spin",
|
|
||||||
"type": "SPIN",
|
|
||||||
"entry_cost": 5,
|
|
||||||
"status": "ACTIVE",
|
|
||||||
"thumbnail_url": "https://…/spin.png",
|
|
||||||
"game_url": "https://…/spin/index.html"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
`entry_cost` adalah EnakCoin yang dipotong setiap kali spin (minimal 1).
|
|
||||||
|
|
||||||
### 2. Buat reward config `PROBABILITY`
|
|
||||||
|
|
||||||
`POST /api/v1/marketing/enakgame/games/:id/reward-configs`
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"reward_type": "PROBABILITY",
|
|
||||||
"max_reward": 50,
|
|
||||||
"rules": {
|
|
||||||
"table": [
|
|
||||||
{ "weight": 50, "amount": 0, "label": "Zonk" },
|
|
||||||
{ "weight": 30, "amount": 3, "label": "3 Coin" },
|
|
||||||
{ "weight": 15, "amount": 10, "label": "10 Coin" },
|
|
||||||
{ "weight": 5, "amount": 50, "label": "Jackpot" }
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"reason": "Spin pertama"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
- Satu baris `table` = satu segmen roda, urut searah gambar roda.
|
|
||||||
- `weight` bilangan bulat ≥ 1. Peluang segmen = `weight` ÷ total weight (di atas: 50%,
|
|
||||||
30%, 15%, 5%). Weight tidak pernah dikirim ke customer.
|
|
||||||
- `amount` EnakCoin yang didapat (boleh 0). `label` opsional, maksimal 100 karakter,
|
|
||||||
ditampilkan di roda.
|
|
||||||
- `max_reward` minimal sebesar `amount` terbesar, kalau tidak hadiah besar terpotong.
|
|
||||||
|
|
||||||
### 3. Aktifkan config
|
|
||||||
|
|
||||||
`POST /api/v1/marketing/enakgame/reward-configs/:id/activate`
|
|
||||||
|
|
||||||
Mengganti hadiah nanti berarti membuat versi config baru lalu mengaktifkannya; session
|
|
||||||
yang sedang berjalan tetap memakai versi saat dimulai.
|
|
||||||
|
|
||||||
### 4. Pastikan ada budget global bulan berjalan
|
|
||||||
|
|
||||||
`POST /api/v1/marketing/enakgame/budgets` dengan `scope: "GLOBAL"`, bila belum ada. Tanpa
|
|
||||||
budget global, customer tidak bisa memulai game apa pun.
|
|
||||||
|
|
||||||
## Alur di Aplikasi Customer
|
|
||||||
|
|
||||||
1. `GET /api/v1/customer/enakgame/games`: game spin punya `prizes`, yaitu segmen roda
|
|
||||||
(`entry`, `label`, `amount`) dalam urutan config. Gambar roda dari sini.
|
|
||||||
2. `POST /api/v1/customer/enakgame/sessions` dengan `{"game_id": "…"}` dan header
|
|
||||||
`Idempotency-Key`. Entry cost dipotong di sini.
|
|
||||||
3. `POST /api/v1/customer/enakgame/sessions/:id/complete` dengan body `{}`. Server yang
|
|
||||||
mengundi. Response berisi `prize` (`entry`, `label`, `amount`): putar roda sampai
|
|
||||||
berhenti di segmen `entry` itu. `reward_total` adalah Coin yang benar-benar masuk,
|
|
||||||
bisa lebih besar dari `prize.amount` karena event, atau lebih kecil karena limit
|
|
||||||
harian (`limited_by`).
|
|
||||||
|
|
||||||
Aplikasi tidak boleh mengundi sendiri atau mengirim hadiah: apa pun yang dikirim selain
|
|
||||||
data hasil diabaikan.
|
|
||||||
@@ -1,548 +0,0 @@
|
|||||||
# Integrasi EnakPoint & EnakCoin — Customer App, POS & Dashboard
|
|
||||||
|
|
||||||
**Migrasi:** `000090`–`000097` · **Base URL:** `/api/v1` · **Kompatibilitas:** endpoint
|
|
||||||
lama tetap jalan sebagai alias (lihat §8)
|
|
||||||
|
|
||||||
Panduan untuk memakai saldo loyalitas dari sisi klien. Alasan di balik setiap aturan
|
|
||||||
ada di [`prd-point-coin.md`](./prd-point-coin.md).
|
|
||||||
|
|
||||||
> **Perubahan 7 Okt 2026:** bayar order dengan EnakPoint sudah dihapus (migrasi
|
|
||||||
> `000102`). EnakPoint sekarang hanya bisa ditukar ke voucher, tidak bisa dipakai
|
|
||||||
> sebagai alat bayar dan tidak bisa dicairkan
|
|
||||||
> ([`enakgame-prd.md`](./enakgame-prd.md) §3.2). Endpoint dan field yang ikut dihapus
|
|
||||||
> ada di §8.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 1. Konsep inti
|
|
||||||
|
|
||||||
| | EnakPoint (`POINT`) | EnakCoin (`COIN`) |
|
|
||||||
|---|---|---|
|
|
||||||
| Didapat dari | Order lunas (per outlet), adjustment admin, exchange | Order lunas (per outlet), adjustment admin |
|
|
||||||
| Dipakai untuk | **Ditukar ke voucher** (tidak bisa membayar order) | **Main game**, ditukar ke EnakPoint |
|
|
||||||
| Bisa ditransfer | Ya | Ya |
|
|
||||||
| Bisa kedaluwarsa | Ya, bila diaktifkan owner | Ya, bila diaktifkan owner |
|
|
||||||
|
|
||||||
Aturan yang berlaku di seluruh dokumen ini:
|
|
||||||
|
|
||||||
1. **Semua jumlah bilangan bulat.** Tidak ada "setengah EnakPoint".
|
|
||||||
2. **Saldo tidak pernah jadi uang.** Tidak ada pencairan, dan EnakPoint tidak bisa
|
|
||||||
dipakai membayar order. Tampilkan nilai rupiahnya sebagai **"setara potongan
|
|
||||||
Rp …"**, bukan "saldo Rp …".
|
|
||||||
3. **Semua aksi customer yang memindahkan saldo butuh PIN 6 digit** (§3): exchange
|
|
||||||
dan transfer. Main game tidak butuh PIN.
|
|
||||||
4. **Wallet milik customer di satu organisasi.** Saldo berlaku di semua outlet
|
|
||||||
organisasi itu. Nilai rupiah EnakPoint, kurs exchange, batas transfer, dan
|
|
||||||
kedaluwarsa diatur per organisasi; earning per outlet.
|
|
||||||
5. **Setiap mutasi tercatat** di riwayat beserta asal atau tujuannya, dan tidak pernah
|
|
||||||
dihapus. Koreksi muncul sebagai baris baru.
|
|
||||||
|
|
||||||
### Format response
|
|
||||||
|
|
||||||
Semua endpoint memakai amplop yang sama:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{ "success": true, "data": { … }, "errors": null }
|
|
||||||
```
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"success": false,
|
|
||||||
"data": null,
|
|
||||||
"errors": [{ "code": "304", "entity": "wallet_service", "cause": "wallet move refused: not enough EnakCoin" }]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
| `code` | HTTP | Arti |
|
|
||||||
|---|---|---|
|
|
||||||
| `303`, `310` | 400 | Body atau parameter tidak lengkap / salah format |
|
|
||||||
| `304` | 400 | Permintaan ditolak aturan bisnis; `cause` menjelaskan alasannya |
|
|
||||||
| `404` | 404 | Tidak ditemukan (juga dipakai untuk data milik customer/organisasi lain) |
|
|
||||||
| `429` | 429 | Terlalu cepat meminta ulang (OTP) |
|
|
||||||
| `PIN_NOT_SET` | 403 | Customer belum membuat PIN |
|
|
||||||
| `PIN_INVALID` | 400 | PIN salah |
|
|
||||||
| `PIN_LOCKED` | 423 | PIN terkunci |
|
|
||||||
| `TRANSFER_BLOCKED` | 403 | Transfer ditahan setelah reset PIN |
|
|
||||||
| `900` | 500 | Kesalahan server |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 2. Customer app — saldo & riwayat
|
|
||||||
|
|
||||||
Semua endpoint customer memakai header `Authorization: Bearer <token customer>`.
|
|
||||||
|
|
||||||
### 2.1 Saldo
|
|
||||||
|
|
||||||
`GET /api/v1/customer/wallet`
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"point_balance": 12500,
|
|
||||||
"coin_balance": 8,
|
|
||||||
"point_value": 1,
|
|
||||||
"point_discount_value": 12500,
|
|
||||||
"nearest_expiring": {
|
|
||||||
"point": { "amount": 150, "date": "2026-12-31" },
|
|
||||||
"coin": null
|
|
||||||
},
|
|
||||||
"recent_transactions": [ … ]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
- `point_balance` dan `coin_balance` adalah saldo yang **bisa dipakai sekarang**.
|
|
||||||
- `point_discount_value` = `point_balance × point_value`. Tampilkan sebagai
|
|
||||||
"setara potongan Rp 12.500".
|
|
||||||
- `nearest_expiring` bernilai `null` per currency bila tidak ada yang akan kedaluwarsa.
|
|
||||||
- `recent_transactions` berisi 5 mutasi terakhir dengan bentuk yang sama seperti §2.2.
|
|
||||||
|
|
||||||
### 2.2 Riwayat
|
|
||||||
|
|
||||||
`GET /api/v1/customer/wallet/transactions?page=1&limit=20¤cy=POINT&type=EARN,TRANSFER_IN&from=2026-09-01&to=2026-09-30`
|
|
||||||
|
|
||||||
Semua query opsional. `limit` 1–100 (default 20). `type` boleh beberapa, dipisah koma.
|
|
||||||
`from` / `to` tanggal WIB, inklusif.
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"data": [
|
|
||||||
{
|
|
||||||
"id": "…",
|
|
||||||
"currency": "POINT",
|
|
||||||
"type": "EARN",
|
|
||||||
"amount": 875,
|
|
||||||
"balance_after": 12500,
|
|
||||||
"description": "Belanja #ORD-0123 di Outlet Kemang",
|
|
||||||
"source": { "type": "ORDER", "id": "…" },
|
|
||||||
"outlet_id": "…",
|
|
||||||
"expires_at": "2026-12-31T23:59:59+07:00",
|
|
||||||
"lots": [{ "amount": 875, "remaining": 875, "expires_at": "2026-12-31T23:59:59+07:00" }],
|
|
||||||
"created_at": "2026-09-30T12:01:00Z"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"pagination": { "page": 1, "limit": 20, "total_count": 42, "total_pages": 3 }
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
- `amount` bertanda: positif menambah saldo, negatif mengurangi.
|
|
||||||
- Penambahan punya `source`, pengurangan punya `destination`. Keduanya berbentuk
|
|
||||||
`{ type, id }` dan menunjuk hal yang bisa dibuka di detail (order, game play,
|
|
||||||
dst.).
|
|
||||||
- `description` sudah siap tampil dan tidak berubah walau nama outlet atau customer
|
|
||||||
berubah belakangan. Nama lawan transfer sudah disamarkan.
|
|
||||||
- Dua baris exchange atau transfer berbagi `group_id` yang sama.
|
|
||||||
|
|
||||||
| `type` | Arah | Arti | `source` / `destination` |
|
|
||||||
|---|---|---|---|
|
|
||||||
| `EARN` | + | Didapat dari order lunas | `ORDER` |
|
|
||||||
| `EARN_REVERSAL` | − | Ditarik karena order di-void/refund | `ORDER` |
|
|
||||||
| `EXCHANGE_OUT` / `EXCHANGE_IN` | − / + | Tukar EnakCoin ke EnakPoint | `WALLET_TX` (baris pasangannya) |
|
|
||||||
| `TRANSFER_OUT` / `TRANSFER_IN` | − / + | Transfer antar customer | `WALLET_TX` (baris pasangannya) |
|
|
||||||
| `GAME_SPEND` | − | Main game | `GAME_PLAY` |
|
|
||||||
| `EXPIRE` | − | Hangus karena kedaluwarsa | `LOT` |
|
|
||||||
| `ADJUSTMENT` | + / − | Koreksi oleh admin | `USER` |
|
|
||||||
| `MIGRATION` | + | Saldo dari sistem lama | `LEGACY_POINTS` / `LEGACY_TOKENS` |
|
|
||||||
|
|
||||||
### 2.3 Yang akan kedaluwarsa
|
|
||||||
|
|
||||||
`GET /api/v1/customer/wallet/expiring`
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"point": [
|
|
||||||
{ "amount": 150, "date": "2026-10-31" },
|
|
||||||
{ "amount": 200, "date": "2026-12-31" }
|
|
||||||
],
|
|
||||||
"coin": []
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Dikelompokkan per tanggal (WIB), paling dekat lebih dulu. Saldo bisa dipakai sampai
|
|
||||||
akhir hari tanggal itu. Daftar kosong berarti tidak ada yang akan kedaluwarsa.
|
|
||||||
|
|
||||||
### 2.4 Notifikasi push (FCM)
|
|
||||||
|
|
||||||
Aplikasi mendaftarkan token FCM-nya **setelah login dan setiap kali FCM memberi token
|
|
||||||
baru**:
|
|
||||||
|
|
||||||
`PUT /api/v1/customer/devices`
|
|
||||||
|
|
||||||
```json
|
|
||||||
{ "device_id": "a1b2c3", "fcm_token": "…", "platform": "android", "app_version": "2.4.0" }
|
|
||||||
```
|
|
||||||
|
|
||||||
`platform`: `android`, `ios`, atau `web` (opsional). Saat logout, panggil
|
|
||||||
`DELETE /api/v1/customer/devices/:device_id` supaya HP itu tidak lagi menerima
|
|
||||||
notifikasi customer tersebut. Satu token hanya milik satu customer: bila customer lain
|
|
||||||
login di HP yang sama dan mendaftarkan token yang sama, customer sebelumnya otomatis
|
|
||||||
tidak menerima notifikasi di HP itu lagi.
|
|
||||||
|
|
||||||
Push yang dikirim, dibedakan lewat `data.type`:
|
|
||||||
|
|
||||||
| `data.type` | Kapan | Isi `data` lainnya |
|
|
||||||
|---|---|---|
|
|
||||||
| `WALLET_TRANSFER_IN` | Menerima transfer | `transaction_id`, `group_id`, `currency`, `amount` |
|
|
||||||
| `WALLET_EXPIRING` | `reminder_days` hari sebelum saldo kedaluwarsa, sekali per tanggal | `currency`, `amount`, `expiry_date` |
|
|
||||||
| `WALLET_EXPIRED` | Saldo baru saja hangus | `currency`, `amount` |
|
|
||||||
| `PIN_LOCKED` | PIN terkunci setelah 5 kali salah | `locked_until` (RFC3339, UTC) |
|
|
||||||
|
|
||||||
Semua nilai di `data` berupa string, sesuai aturan FCM.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 3. Customer app — PIN
|
|
||||||
|
|
||||||
PIN 6 digit, terpisah dari password login, dikirim sebagai **string** supaya angka nol
|
|
||||||
di depan tidak hilang. PIN tidak pernah dikembalikan di response.
|
|
||||||
|
|
||||||
### 3.1 Cek status
|
|
||||||
|
|
||||||
`GET /api/v1/customer/pin/status`
|
|
||||||
|
|
||||||
```json
|
|
||||||
{ "has_pin": true, "locked_until": null, "transfer_blocked_until": null }
|
|
||||||
```
|
|
||||||
|
|
||||||
Minta customer membuat PIN saat pertama kali ia melakukan aksi yang butuh PIN
|
|
||||||
(`has_pin: false`), bukan saat registrasi.
|
|
||||||
|
|
||||||
### 3.2 Membuat PIN pertama kali
|
|
||||||
|
|
||||||
1. `POST /api/v1/customer/pin/otp` dengan `{ "purpose": "pin_setup" }`. OTP dikirim ke
|
|
||||||
nomor customer lewat WhatsApp. Response: `{ "purpose", "otp_token", "expires_at" }`.
|
|
||||||
2. `POST /api/v1/customer/pin` dengan
|
|
||||||
`{ "otp_token": "…", "otp_code": "123456", "pin": "482913", "confirm_pin": "482913" }`.
|
|
||||||
|
|
||||||
PIN ditolak (`304`) bila bukan 6 digit, konfirmasinya beda, semua digit sama
|
|
||||||
(`111111`), berurutan (`123456`, `654321`), atau sama dengan tanggal lahir
|
|
||||||
(`DDMMYY` / `YYMMDD`). Tampilkan `cause` apa adanya. Meminta OTP terlalu cepat
|
|
||||||
menghasilkan `429`.
|
|
||||||
|
|
||||||
### 3.3 Mengganti dan mereset PIN
|
|
||||||
|
|
||||||
- **Ganti:** `PUT /api/v1/customer/pin` dengan `{ "old_pin", "pin", "confirm_pin" }`.
|
|
||||||
- **Lupa PIN:** minta OTP dengan `purpose: "pin_reset"`, lalu
|
|
||||||
`POST /api/v1/customer/pin/reset` dengan body yang sama seperti §3.2. Reset juga
|
|
||||||
membuka PIN yang terkunci. Setelah reset, **transfer keluar ditahan 24 jam**;
|
|
||||||
exchange tetap bisa.
|
|
||||||
|
|
||||||
### 3.4 Menangani error PIN
|
|
||||||
|
|
||||||
Setiap endpoint yang menerima `pin` bisa mengembalikan error PIN. Pada error ini `data`
|
|
||||||
**tidak** `null`:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"success": false,
|
|
||||||
"data": { "code": "PIN_INVALID", "remaining_attempts": 3 },
|
|
||||||
"errors": [{ "code": "PIN_INVALID", "entity": "customer_pin_service", "cause": "wrong PIN, 3 attempts left" }]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
| `data.code` | Field tambahan | Yang ditampilkan aplikasi |
|
|
||||||
|---|---|---|
|
|
||||||
| `PIN_NOT_SET` | – | Arahkan ke pembuatan PIN (§3.2) |
|
|
||||||
| `PIN_INVALID` | `remaining_attempts` | "PIN salah, sisa 3 percobaan" |
|
|
||||||
| `PIN_LOCKED` | `locked_until` | "PIN terkunci sampai 14:30", tawarkan reset PIN |
|
|
||||||
| `TRANSFER_BLOCKED` | `transfer_blocked_until` | "Transfer bisa dilakukan lagi pada …" |
|
|
||||||
|
|
||||||
Lima kali salah berturut-turut mengunci PIN selama 30 menit. Selama terkunci, PIN yang
|
|
||||||
benar pun ditolak. Penghitung disimpan di server, jadi tidak bisa diakali dengan
|
|
||||||
reinstall atau ganti HP.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 4. Earning, void, dan refund
|
|
||||||
|
|
||||||
EnakPoint bukan payment method: tidak ada payment method bertipe `point`, dan
|
|
||||||
`POST /api/v1/payments` memakai `amount` seperti pembayaran lain. Kode bayar,
|
|
||||||
bayar dari aplikasi, dan preview pembayaran EnakPoint sudah dihapus (§8).
|
|
||||||
|
|
||||||
Response order membawa `points_earned` dan `coins_earned` (0 bila order tidak
|
|
||||||
menghasilkan apa-apa). Earning dihitung dari `subtotal − discount`, sebelum pajak, dan
|
|
||||||
diberikan saat order lunas.
|
|
||||||
|
|
||||||
EnakPoint dan EnakCoin yang didapat dari order ikut ditarik saat void/refund. Bila
|
|
||||||
saldo customer sudah terpakai, yang ditarik sebanyak yang ada; refund tidak pernah
|
|
||||||
diblokir karena ini.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 5. Exchange EnakCoin → EnakPoint
|
|
||||||
|
|
||||||
Kurs per organisasi: `coin_amount` EnakCoin = `point_amount` EnakPoint (default 1 : 1).
|
|
||||||
|
|
||||||
1. **Preview** sebelum minta PIN:
|
|
||||||
|
|
||||||
`GET /api/v1/customer/wallet/exchange/preview?coins=30`
|
|
||||||
|
|
||||||
```json
|
|
||||||
{ "coin_amount": 10, "point_amount": 3, "coin_balance": 35, "coins": 30, "points": 9, "valid": true }
|
|
||||||
```
|
|
||||||
|
|
||||||
Bila `valid: false`, tampilkan `reason` (misalnya harus kelipatan `coin_amount`,
|
|
||||||
atau EnakCoin tidak cukup).
|
|
||||||
|
|
||||||
2. **Tukar:**
|
|
||||||
|
|
||||||
`POST /api/v1/customer/wallet/exchange` dengan header **`Idempotency-Key`** (wajib,
|
|
||||||
maks. 50 karakter, satu key per percobaan tukar)
|
|
||||||
|
|
||||||
```json
|
|
||||||
{ "coins": 30, "pin": "482913" }
|
|
||||||
```
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"group_id": "…",
|
|
||||||
"coins": 30,
|
|
||||||
"points": 9,
|
|
||||||
"coin_amount": 10,
|
|
||||||
"point_amount": 3,
|
|
||||||
"lots": [{ "amount": 9, "expires_at": "2026-12-31T23:59:59+07:00" }],
|
|
||||||
"coin_balance": 5,
|
|
||||||
"point_balance": 9,
|
|
||||||
"replayed": false
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
- Jumlah EnakCoin harus kelipatan `coin_amount`. Kesalahan jumlah ditolak **sebelum**
|
|
||||||
PIN dicek, jadi tidak memakan jatah percobaan PIN.
|
|
||||||
- Exchange tidak bisa dibatalkan; tampilkan konfirmasi.
|
|
||||||
- Kirim ulang dengan `Idempotency-Key` yang sama bila koneksi putus: hasil pertama
|
|
||||||
dikembalikan dengan `replayed: true` tanpa menukar lagi, dengan kurs saat itu.
|
|
||||||
`Idempotency-Key` yang sama untuk jumlah berbeda ditolak.
|
|
||||||
- EnakPoint hasil tukar tidak bisa hidup lebih lama dari EnakCoin asalnya (`lots`
|
|
||||||
menunjukkan tanggalnya).
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 6. Transfer ke customer lain
|
|
||||||
|
|
||||||
1. **Cek penerima** sebelum konfirmasi:
|
|
||||||
|
|
||||||
`GET /api/v1/customer/wallet/transfer/recipient?phone=081234561234`
|
|
||||||
|
|
||||||
```json
|
|
||||||
{ "name": "Bu*** Sa***", "phone_number": "08**-****-1234" }
|
|
||||||
```
|
|
||||||
|
|
||||||
Nomor yang tidak terdaftar di organisasi yang sama dijawab `404`. Diri sendiri,
|
|
||||||
customer walk-in, atau customer nonaktif dijawab `304`.
|
|
||||||
|
|
||||||
2. **Kirim:**
|
|
||||||
|
|
||||||
`POST /api/v1/customer/wallet/transfer` dengan header **`Idempotency-Key`** (wajib)
|
|
||||||
|
|
||||||
```json
|
|
||||||
{ "currency": "POINT", "amount": 120, "recipient_phone": "081234561234", "pin": "482913" }
|
|
||||||
```
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"group_id": "…",
|
|
||||||
"currency": "POINT",
|
|
||||||
"amount": 120,
|
|
||||||
"recipient": { "name": "Bu*** Sa***", "phone_number": "08**-****-1234" },
|
|
||||||
"lots": [
|
|
||||||
{ "amount": 100, "expires_at": "2026-12-31T23:59:59+07:00" },
|
|
||||||
{ "amount": 20, "expires_at": null }
|
|
||||||
],
|
|
||||||
"balance": 30,
|
|
||||||
"replayed": false
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
- `currency`: `POINT` atau `COIN`, satu jenis per transfer.
|
|
||||||
- Batas dari organisasi: transfer bisa dimatikan, ada minimal, maksimal per
|
|
||||||
transaksi, dan batas harian per currency (reset tengah malam WIB). Pelanggaran batas
|
|
||||||
ditolak `304` sebelum PIN dicek.
|
|
||||||
- Transfer final dan tidak bisa dibatalkan customer.
|
|
||||||
- Saldo yang dikirim membawa tanggal kedaluwarsa aslinya ke penerima (`lots`).
|
|
||||||
Tampilkan ini ke pengirim.
|
|
||||||
- Penerima mendapat push `WALLET_TRANSFER_IN` (§2.4).
|
|
||||||
- Retry dengan `Idempotency-Key` yang sama mengembalikan hasil pertama
|
|
||||||
(`replayed: true`) dan tidak dihitung dua kali terhadap batas harian.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 7. Game
|
|
||||||
|
|
||||||
Game lama (`POST /api/v1/customer/spin`, `GET /customer/games`,
|
|
||||||
`GET /customer/ferris-wheel`, dan admin `/marketing/games`, `/marketing/game-prizes`,
|
|
||||||
`/marketing/rewards`) sudah dihapus. Semua game, termasuk spin, sekarang game EnakGame:
|
|
||||||
|
|
||||||
- Customer: `GET /api/v1/customer/enakgame/games`, lalu
|
|
||||||
`POST /api/v1/customer/enakgame/sessions` (wajib `Idempotency-Key`, memotong
|
|
||||||
`entry_cost` EnakCoin), lalu `POST /api/v1/customer/enakgame/sessions/:id/complete`
|
|
||||||
(server menghitung hadiah EnakCoin). Tanpa PIN.
|
|
||||||
- Dashboard: game dan biaya per main (`entry_cost`, bilangan bulat ≥ 1) diatur di
|
|
||||||
`/marketing/enakgame/games`, hadiahnya di reward config.
|
|
||||||
|
|
||||||
Langkah admin dan alur aplikasi untuk spin ada di [`enakgame-spin.md`](enakgame-spin.md).
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 8. Endpoint lama (deprecated)
|
|
||||||
|
|
||||||
Masih jalan dan membaca saldo wallet, tapi akan dihapus setelah semua versi aplikasi
|
|
||||||
pindah. Aplikasi baru jangan memakainya.
|
|
||||||
|
|
||||||
| Lama | Ganti dengan |
|
|
||||||
|---|---|
|
|
||||||
| `GET /customer/points` | `GET /customer/wallet` (`point_balance`) |
|
|
||||||
| `total_points`, `points_history`, `last_updated` di `/customer/wallet` | `point_balance`, `recent_transactions` |
|
|
||||||
|
|
||||||
Beri tahu tim backend setelah aplikasi yang beredar tidak lagi memakai kolom kiri,
|
|
||||||
supaya alias ini bisa dihapus.
|
|
||||||
|
|
||||||
Semua yang bernama token sudah dihapus: `GET /customer/tokens`, `total_tokens`,
|
|
||||||
`tokens_history`, `token_used`, `tokens_remaining`, dan nilai `TOKENS` di campaign. Pakai
|
|
||||||
`coin_balance`, `coins_used`, `coins_remaining`, dan `COINS`.
|
|
||||||
|
|
||||||
Bayar dengan EnakPoint juga sudah dihapus (7 Okt 2026, migrasi `000102`) karena
|
|
||||||
EnakPoint sekarang hanya untuk voucher ([`enakgame-prd.md`](./enakgame-prd.md) §3.2).
|
|
||||||
Tidak ada penggantinya:
|
|
||||||
|
|
||||||
- Endpoint `POST /customer/wallet/payment-code`, `POST /customer/orders/:id/pay-with-points`,
|
|
||||||
dan `GET /orders/:id/point-payment/preview`.
|
|
||||||
- Payment method tipe `point`, serta field `points` dan `payment_code` di
|
|
||||||
`POST /payments`; `amount` kembali wajib seperti pembayaran lain.
|
|
||||||
- `points_used` dan `point_value` di response pembayaran dan di `payments` pada
|
|
||||||
`GET /customer/orders/:id`; `accepts_point_payment` di `GET /customer/outlets`.
|
|
||||||
- Objek `point_payment` (`accept_payment`, `min_payment_points`,
|
|
||||||
`max_payment_percent`) di setting outlet (§9.1).
|
|
||||||
- Di analytics payment method: `point_amount`, `points_used`, `total_with_points` di
|
|
||||||
`summary`, serta `points_used` dan `counts_as_cash_in` per baris.
|
|
||||||
`summary.total_amount` kembali total semua method, dan persentase dihitung dari total
|
|
||||||
itu.
|
|
||||||
- Tipe mutasi `PAYMENT` dan `PAYMENT_REFUND` tidak ditulis lagi.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 9. Dashboard
|
|
||||||
|
|
||||||
Semua endpoint di bagian ini butuh login user dengan role Admin atau Manager.
|
|
||||||
|
|
||||||
### 9.1 Pengaturan per outlet
|
|
||||||
|
|
||||||
`GET` / `PUT /api/v1/outlets/:outlet_id/loyalty-settings`
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"point": { "enabled": true, "earn_mode": "PER_AMOUNT", "earn_per_amount": 100, "earn_value": 1, "earn_percent": 1, "min_order_amount": 0, "max_per_order": null },
|
|
||||||
"coin": { "enabled": true, "earn_mode": "PER_AMOUNT", "earn_per_amount": 25000, "earn_value": 1, "earn_percent": 1, "min_order_amount": 0, "max_per_order": null }
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Field yang tidak dikirim di `PUT` tetap memakai nilai sekarang. `PUT` yang masih
|
|
||||||
mengirim `point_payment` ditolak `310` (field tidak dikenal). Response menambahkan
|
|
||||||
`point_value` organisasi dan `point_cashback_percent`
|
|
||||||
(`earn_value × point_value / earn_per_amount × 100`, atau `earn_percent × point_value`
|
|
||||||
pada `earn_mode` `PERCENTAGE`). **Tampilkan persentase ini di
|
|
||||||
samping setting** supaya owner tidak salah membaca skala: default di atas setara
|
|
||||||
cashback 1%.
|
|
||||||
|
|
||||||
### 9.2 Pengaturan organisasi
|
|
||||||
|
|
||||||
`GET` / `PUT /api/v1/marketing/loyalty-settings` (tambah `?dry_run=true` untuk preview
|
|
||||||
tanpa menyimpan)
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"point_value": 1,
|
|
||||||
"exchange": { "coin_amount": 1, "point_amount": 1 },
|
|
||||||
"transfer": { "enabled": true, "min_amount": 1, "max_per_transaction": null, "daily_limit": null },
|
|
||||||
"point_expiry": {
|
|
||||||
"enabled": false,
|
|
||||||
"mode": "FIXED_DATE",
|
|
||||||
"fixed_dates": ["12-31"],
|
|
||||||
"grace_months": 3,
|
|
||||||
"period": 12,
|
|
||||||
"unit": "MONTH",
|
|
||||||
"end_of_month": false,
|
|
||||||
"reminder_days": 7
|
|
||||||
},
|
|
||||||
"coin_expiry": { … sama … },
|
|
||||||
"enakgame": { "user_daily_limit": 0, "global_daily_limit": 0 }
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Field yang tidak dikirim di `PUT` tetap memakai nilai sekarang. Response menambahkan:
|
|
||||||
|
|
||||||
- `impact`: total saldo beredar dan nilai rupiahnya **sebelum dan sesudah** perubahan
|
|
||||||
`point_value` atau kurs. Tampilkan sebagai peringatan sebelum owner menyimpan.
|
|
||||||
- `expiry_preview`: `{ "point": …, "coin": … }`, kapan saldo yang didapat hari ini
|
|
||||||
akan kedaluwarsa (`null` bila tidak kedaluwarsa). Tampilkan sebagai "EnakPoint yang
|
|
||||||
didapat hari ini kedaluwarsa pada 31 Des 2026".
|
|
||||||
- `expiry_activations`: bila perubahan ini **menyalakan** kedaluwarsa untuk pertama
|
|
||||||
kali, berapa saldo lama yang ikut diberi tanggal (`lots`, `amount`) dan tanggalnya
|
|
||||||
(`expires_at`). Selalu minta konfirmasi dengan `dry_run=true` dulu.
|
|
||||||
- `changes`: key yang berubah.
|
|
||||||
|
|
||||||
**Kedaluwarsa** diatur per currency dengan salah satu model:
|
|
||||||
|
|
||||||
| `mode` | Cara kerja | Field yang dipakai |
|
|
||||||
|---|---|---|
|
|
||||||
| `FIXED_DATE` (default) | Semua saldo hangus di tanggal tetap setiap tahun. Saldo yang didapat kurang dari `grace_months` sebelum tanggal itu ikut ke tanggal berikutnya | `fixed_dates` (format `MM-DD`, boleh lebih dari satu, `02-29` ditolak), `grace_months` (0–24) |
|
|
||||||
| `ROLLING` | Tiap saldo berlaku sekian lama sejak didapat | `period`, `unit` (`DAY` / `MONTH`), `end_of_month` |
|
|
||||||
|
|
||||||
- `reminder_days` berlaku untuk keduanya: customer diingatkan sekian hari sebelum
|
|
||||||
hangus (0 = tanpa pengingat).
|
|
||||||
- Mengubah pengaturan hanya berlaku untuk saldo yang masuk setelahnya.
|
|
||||||
- Menyalakan kedaluwarsa pertama kali memberi saldo lama masa berlaku penuh: tanggal
|
|
||||||
hangus kedua berikutnya (`FIXED_DATE`) atau satu periode penuh (`ROLLING`).
|
|
||||||
- Mematikan kedaluwarsa tidak membatalkan tanggal yang sudah terjadwal.
|
|
||||||
|
|
||||||
Riwayat perubahan: `GET /api/v1/marketing/loyalty-settings/history?page=1&limit=20`
|
|
||||||
(tambah `outlet_id=` untuk setting outlet).
|
|
||||||
|
|
||||||
### 9.3 Wallet customer
|
|
||||||
|
|
||||||
- `GET /api/v1/marketing/customers/:id/wallet` — saldo buku dan saldo yang bisa
|
|
||||||
dipakai, semua lot yang masih berisi, dan riwayat dengan nama asli (lawan transfer,
|
|
||||||
admin, kasir, outlet). Query riwayat sama seperti §2.2.
|
|
||||||
- `POST /api/v1/marketing/customers/:id/wallet/adjust`
|
|
||||||
|
|
||||||
```json
|
|
||||||
{ "currency": "POINT", "amount": -500, "reason": "Komplain #45", "idempotency_key": "adj-45" }
|
|
||||||
```
|
|
||||||
|
|
||||||
`amount` bertanda. `reason` wajib. Pengurangan yang melebihi saldo ditolak.
|
|
||||||
Adjustment tidak disertai pembayaran uang, jadi jangan pakai alasan "pencairan".
|
|
||||||
|
|
||||||
- `GET /api/v1/marketing/wallet-transactions/:id/trace` — telusuri satu mutasi per
|
|
||||||
butir: lot mana yang dipakai atau dibuat, lalu rantai asalnya lewat transfer atau
|
|
||||||
exchange sampai ke earning/adjustment/migrasi pertama. Contoh: dari transfer keluar
|
|
||||||
B bisa terlihat bahwa EnakPoint-nya berasal dari order #ORD-1 milik A yang
|
|
||||||
mentransfer ke B.
|
|
||||||
|
|
||||||
### 9.4 PIN customer
|
|
||||||
|
|
||||||
- `DELETE /api/v1/marketing/customers/:id/pin` dengan `{ "reason": "…" }` — hapus PIN
|
|
||||||
bila customer kehilangan akses. Customer lalu membuat PIN baru lewat OTP. Admin
|
|
||||||
**tidak bisa** membuat, mengganti, atau melihat PIN.
|
|
||||||
- `GET /api/v1/marketing/customers/:id/security-events?page=1&limit=20` — log keamanan:
|
|
||||||
`PIN_SET`, `PIN_CHANGED`, `PIN_RESET`, `PIN_FAILED`, `PIN_LOCKED`,
|
|
||||||
`PIN_REMOVED_BY_ADMIN`, beserta waktu, IP, dan perangkat.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 10. Checklist integrasi
|
|
||||||
|
|
||||||
**Customer app**
|
|
||||||
- [ ] Daftarkan token FCM setelah login dan saat token berganti; hapus saat logout.
|
|
||||||
- [ ] Tangani empat kode error PIN (§3.4) di semua layar yang meminta PIN.
|
|
||||||
- [ ] Kirim `Idempotency-Key` baru untuk setiap exchange dan transfer, dan pakai ulang
|
|
||||||
key yang sama saat retry.
|
|
||||||
- [ ] Tampilkan nilai rupiah sebagai "setara potongan", bukan saldo uang.
|
|
||||||
- [ ] Baca `coins_used` / `coins_remaining` dan `/customer/wallet`, bukan field lama.
|
|
||||||
|
|
||||||
**POS**
|
|
||||||
- [ ] Cetak `points_earned` dan `coins_earned` di struk.
|
|
||||||
- [ ] Jangan menampilkan EnakPoint sebagai payment method (§4).
|
|
||||||
|
|
||||||
**Dashboard**
|
|
||||||
- [ ] Tampilkan `point_cashback_percent`, `impact`, `expiry_preview`, dan
|
|
||||||
`expiry_activations` sebelum owner menyimpan setting.
|
|
||||||
- [ ] Buat ulang game (termasuk spin) di `/marketing/enakgame/games` dengan `entry_cost`
|
|
||||||
dan reward config ([`enakgame-spin.md`](enakgame-spin.md)).
|
|
||||||
@@ -1,583 +0,0 @@
|
|||||||
# Prompt: fitur EnakPoint & EnakCoin di Mobile App Customer
|
|
||||||
|
|
||||||
Kamu mengerjakan aplikasi mobile untuk **customer** (bukan kasir, bukan backoffice).
|
|
||||||
Tugasmu: membangun fitur loyalitas EnakPoint & EnakCoin di aplikasi, memakai API backend
|
|
||||||
yang sudah jadi dan dijelaskan di dokumen ini. Jangan mengarang endpoint, field, atau
|
|
||||||
aturan yang tidak tertulis di sini; kalau ada yang kurang jelas, tanyakan dulu.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 1. Konteks bisnis
|
|
||||||
|
|
||||||
| | EnakPoint (`POINT`) | EnakCoin (`COIN`) |
|
|
||||||
|---|---|---|
|
|
||||||
| Didapat dari | Belanja (order lunas), koreksi admin, tukar EnakCoin | Belanja, koreksi admin |
|
|
||||||
| Dipakai untuk | **Ditukar ke voucher** (tidak bisa membayar order) | **Main game**, ditukar ke EnakPoint |
|
|
||||||
| Bisa dikirim ke customer lain | Ya | Ya |
|
|
||||||
| Bisa kedaluwarsa | Ya, bila owner mengaktifkan | Ya, bila owner mengaktifkan |
|
|
||||||
|
|
||||||
Tidak ada lagi "token". Semua yang dulu token sekarang EnakCoin, dan endpoint serta
|
|
||||||
field bernama token sudah dihapus dari API.
|
|
||||||
|
|
||||||
> **Perubahan 7 Okt 2026:** bayar dengan EnakPoint (kode bayar di kasir, bayar order
|
|
||||||
> dari app) sudah dihapus dari backend. EnakPoint sekarang hanya bisa ditukar ke
|
|
||||||
> voucher, tidak bisa dipakai sebagai alat bayar dan tidak bisa dicairkan
|
|
||||||
> ([`enakgame-prd.md`](./enakgame-prd.md) §3.2). Jangan membangun layar bayar atau kode
|
|
||||||
> bayar; endpoint dan field yang dihapus ada di §9.
|
|
||||||
|
|
||||||
### Aturan yang wajib dipatuhi di UI
|
|
||||||
|
|
||||||
1. **Semua jumlah bilangan bulat.** Tidak ada desimal pada EnakPoint atau EnakCoin.
|
|
||||||
2. **Saldo bukan uang.** Nilai rupiah EnakPoint selalu ditulis **"setara potongan
|
|
||||||
Rp …"**, tidak pernah "saldo Rp …" atau "uang". Tidak ada fitur tarik tunai, dan
|
|
||||||
EnakPoint tidak bisa dipakai membayar.
|
|
||||||
3. **PIN 6 digit wajib** untuk: tukar EnakCoin dan transfer. **Main game tidak butuh PIN.** Melihat saldo dan riwayat
|
|
||||||
tidak butuh PIN.
|
|
||||||
4. **PIN terpisah dari password login** dan selalu dikirim sebagai **string** (supaya
|
|
||||||
nol di depan tidak hilang). Jangan pernah menyimpan PIN di perangkat, log, atau
|
|
||||||
analytics.
|
|
||||||
5. **Satu akun customer = satu organisasi.** Saldo berlaku di semua outlet organisasi itu.
|
|
||||||
6. **Waktu memakai WIB.** Tanggal kedaluwarsa berarti saldo masih bisa dipakai sampai
|
|
||||||
23:59:59 WIB di tanggal itu.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 2. Koneksi ke API
|
|
||||||
|
|
||||||
- Base URL: `/api/v1`
|
|
||||||
- Semua endpoint customer: header `Authorization: Bearer <token login customer>`
|
|
||||||
- Semua jumlah di request dan response berupa integer.
|
|
||||||
|
|
||||||
### Registrasi customer
|
|
||||||
|
|
||||||
`POST /api/v1/customer-auth/register/start` menerima `organization_id` (opsional):
|
|
||||||
|
|
||||||
```json
|
|
||||||
{ "phone_number": "0812…", "name": "Budi", "birth_date": "2000-01-31", "organization_id": "648b96a0-1d1d-414e-baee-37e9d6317b4e" }
|
|
||||||
```
|
|
||||||
|
|
||||||
- Customer terdaftar di satu organisasi, dan saldonya berlaku di semua outlet organisasi itu.
|
|
||||||
- Bila `organization_id` tidak dikirim dan backend hanya punya satu organisasi, customer
|
|
||||||
otomatis masuk ke organisasi itu. Bila ada lebih dari satu, registrasi ditolak
|
|
||||||
("organization_id is required"), jadi sebaiknya app selalu mengirimnya dari config per
|
|
||||||
environment/brand.
|
|
||||||
- `organization_id` yang dikirim harus ada; bila tidak, registrasi ditolak sebelum OTP dikirim.
|
|
||||||
- Wallet customer baru belum punya baris sampai saldo pertama kali bergerak;
|
|
||||||
`GET /customer/wallet` tetap menjawab saldo 0.
|
|
||||||
|
|
||||||
### Format response
|
|
||||||
|
|
||||||
Sukses:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{ "success": true, "data": { … }, "errors": null }
|
|
||||||
```
|
|
||||||
|
|
||||||
Gagal:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{ "success": false, "data": null, "errors": [{ "code": "304", "entity": "wallet_service", "cause": "wallet move refused: not enough EnakCoin" }] }
|
|
||||||
```
|
|
||||||
|
|
||||||
| `errors[0].code` | HTTP | Arti | Yang dilakukan app |
|
|
||||||
|---|---|---|---|
|
|
||||||
| `303`, `310` | 400 | Request tidak lengkap / salah format | Bug di app; tampilkan pesan umum |
|
|
||||||
| `304` | 400 | Ditolak aturan bisnis | Tampilkan pesan yang ramah (lihat tiap fitur); `cause` berbahasa Inggris, jangan tampilkan mentah |
|
|
||||||
| `404` | 404 | Tidak ditemukan | Tampilkan "tidak ditemukan" |
|
|
||||||
| `429` | 429 | Minta OTP terlalu cepat | Tampilkan hitung mundur sebelum boleh minta lagi |
|
|
||||||
| `PIN_NOT_SET` | 403 | Belum punya PIN | Buka alur buat PIN (§6.2) |
|
|
||||||
| `PIN_INVALID` | 400 | PIN salah | §6.5 |
|
|
||||||
| `PIN_LOCKED` | 423 | PIN terkunci | §6.5 |
|
|
||||||
| `TRANSFER_BLOCKED` | 403 | Transfer ditahan setelah reset PIN | §6.5 |
|
|
||||||
| `900` | 500 | Error server | "Terjadi kesalahan, coba lagi" |
|
|
||||||
|
|
||||||
### Idempotency-Key
|
|
||||||
|
|
||||||
Endpoint **tukar** dan **transfer** wajib header `Idempotency-Key` (string unik, maks.
|
|
||||||
50 karakter, mis. UUID v4).
|
|
||||||
|
|
||||||
- Buat **satu key baru saat customer menekan tombol konfirmasi**.
|
|
||||||
- Bila request gagal karena jaringan/timeout, **kirim ulang dengan key yang sama**.
|
|
||||||
Server mengembalikan hasil pertama dengan `"replayed": true` dan tidak memotong saldo
|
|
||||||
dua kali.
|
|
||||||
- Jangan pakai ulang key untuk transaksi yang berbeda; server menolaknya (`304`).
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 3. Layar yang perlu dibuat
|
|
||||||
|
|
||||||
| Layar | Endpoint utama | Butuh PIN |
|
|
||||||
|---|---|---|
|
|
||||||
| Beranda wallet | `GET /customer/wallet` | – |
|
|
||||||
| Riwayat mutasi | `GET /customer/wallet/transactions` | – |
|
|
||||||
| Saldo akan kedaluwarsa | `GET /customer/wallet/expiring` | – |
|
|
||||||
| Daftar outlet | `GET /customer/outlets` | – |
|
|
||||||
| Riwayat order + detail | `GET /customer/orders`, `GET /customer/orders/:id` | – |
|
|
||||||
| Tukar EnakCoin | `GET …/exchange/preview`, `POST /customer/wallet/exchange` | Ya |
|
|
||||||
| Transfer | `GET …/transfer/recipient`, `POST /customer/wallet/transfer` | Ya |
|
|
||||||
| PIN (buat, ganti, lupa) | `/customer/pin/*` | – |
|
|
||||||
| Game | `GET /customer/enakgame/games`, `POST /customer/enakgame/sessions`, `POST …/sessions/:id/complete` | – |
|
|
||||||
| (latar belakang) registrasi push | `PUT` / `DELETE /customer/devices` | – |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 4. Beranda wallet, riwayat, kedaluwarsa
|
|
||||||
|
|
||||||
### 4.1 Beranda — `GET /customer/wallet`
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"point_balance": 12500,
|
|
||||||
"coin_balance": 8,
|
|
||||||
"point_value": 1,
|
|
||||||
"point_discount_value": 12500,
|
|
||||||
"nearest_expiring": {
|
|
||||||
"point": { "amount": 150, "date": "2026-12-31" },
|
|
||||||
"coin": null
|
|
||||||
},
|
|
||||||
"recent_transactions": [ /* sama dengan item riwayat §4.2, maksimal 5 */ ]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Tampilkan:
|
|
||||||
- Saldo EnakPoint (`point_balance`) dengan keterangan "setara potongan Rp
|
|
||||||
{point_discount_value}" (format ribuan Indonesia: `Rp 12.500`).
|
|
||||||
- Saldo EnakCoin (`coin_balance`).
|
|
||||||
- Bila `nearest_expiring.point` / `.coin` tidak `null`: banner "{amount} EnakPoint akan
|
|
||||||
kedaluwarsa pada {date}" yang membuka layar §4.3.
|
|
||||||
- 5 mutasi terakhir dari `recent_transactions`, dengan tautan "Lihat semua" ke §4.2.
|
|
||||||
- Tombol aksi: Tukar EnakCoin (§7.1), Transfer (§7.2), Main game (§8).
|
|
||||||
|
|
||||||
Muat ulang beranda setelah setiap transaksi dan saat menerima push (§5).
|
|
||||||
|
|
||||||
Field `total_points`, `points_history`, `last_updated` di response ini **deprecated**;
|
|
||||||
jangan dipakai.
|
|
||||||
|
|
||||||
### 4.2 Riwayat — `GET /customer/wallet/transactions`
|
|
||||||
|
|
||||||
Query (semua opsional):
|
|
||||||
|
|
||||||
| Query | Contoh | Keterangan |
|
|
||||||
|---|---|---|
|
|
||||||
| `page` | `1` | Mulai dari 1 |
|
|
||||||
| `limit` | `20` | 1–100, default 20 |
|
|
||||||
| `currency` | `POINT` | `POINT` atau `COIN`; untuk tab EnakPoint / EnakCoin |
|
|
||||||
| `type` | `EARN,TRANSFER_IN` | Satu atau beberapa tipe dipisah koma, untuk filter |
|
|
||||||
| `from`, `to` | `2026-09-01` | Tanggal WIB, inklusif |
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"data": [
|
|
||||||
{
|
|
||||||
"id": "…",
|
|
||||||
"currency": "POINT",
|
|
||||||
"type": "EARN",
|
|
||||||
"amount": 875,
|
|
||||||
"balance_after": 12500,
|
|
||||||
"description": "Belanja #ORD-0123 di Outlet Kemang",
|
|
||||||
"source": { "type": "ORDER", "id": "…" },
|
|
||||||
"outlet_id": "…",
|
|
||||||
"group_id": null,
|
|
||||||
"expires_at": "2026-12-31T23:59:59+07:00",
|
|
||||||
"lots": [{ "amount": 875, "remaining": 875, "expires_at": "2026-12-31T23:59:59+07:00" }],
|
|
||||||
"created_at": "2026-09-30T12:01:00Z"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"pagination": { "page": 1, "limit": 20, "total_count": 42, "total_pages": 3 }
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Aturan tampilan:
|
|
||||||
- `amount` bertanda: positif tampil hijau dengan `+`, negatif merah dengan `−`.
|
|
||||||
- `description` sudah siap tampil (nama lawan transfer sudah disamarkan). Tampilkan apa
|
|
||||||
adanya.
|
|
||||||
- Mutasi masuk yang punya `expires_at` menampilkan "Berlaku sampai {tanggal}".
|
|
||||||
- Infinite scroll memakai `pagination.total_pages`.
|
|
||||||
- Riwayat tidak pernah berubah atau hilang; koreksi muncul sebagai baris baru.
|
|
||||||
|
|
||||||
Label tipe:
|
|
||||||
|
|
||||||
| `type` | Label | Arah |
|
|
||||||
|---|---|---|
|
|
||||||
| `EARN` | Dari belanja | + |
|
|
||||||
| `EARN_REVERSAL` | Dibatalkan (order di-void/refund) | − |
|
|
||||||
| `EXCHANGE_OUT` | Ditukar ke EnakPoint | − |
|
|
||||||
| `EXCHANGE_IN` | Hasil tukar EnakCoin | + |
|
|
||||||
| `TRANSFER_OUT` | Transfer keluar | − |
|
|
||||||
| `TRANSFER_IN` | Transfer masuk | + |
|
|
||||||
| `GAME_SPEND` | Main game | − |
|
|
||||||
| `EXPIRE` | Kedaluwarsa | − |
|
|
||||||
| `ADJUSTMENT` | Koreksi | + / − |
|
|
||||||
| `MIGRATION` | Saldo awal | + |
|
|
||||||
|
|
||||||
### 4.3 Akan kedaluwarsa — `GET /customer/wallet/expiring`
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"point": [
|
|
||||||
{ "amount": 150, "date": "2026-10-31" },
|
|
||||||
{ "amount": 200, "date": "2026-12-31" }
|
|
||||||
],
|
|
||||||
"coin": []
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Daftar per tanggal, paling dekat di atas. Daftar kosong: tampilkan "Tidak ada saldo
|
|
||||||
yang akan kedaluwarsa". Saldo yang kedaluwarsa hangus tanpa kompensasi.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### 4.4 Daftar outlet — `GET /customer/outlets`
|
|
||||||
|
|
||||||
Outlet aktif di organisasi customer, tempat saldo EnakPoint & EnakCoin berlaku. Urut
|
|
||||||
berdasarkan nama.
|
|
||||||
|
|
||||||
```json
|
|
||||||
[
|
|
||||||
{
|
|
||||||
"id": "…",
|
|
||||||
"name": "Gokuna Kemang",
|
|
||||||
"address": "Jl. Kemang Raya 10",
|
|
||||||
"earns_points": true,
|
|
||||||
"earns_coins": false
|
|
||||||
}
|
|
||||||
]
|
|
||||||
```
|
|
||||||
|
|
||||||
- `address` bisa `null`.
|
|
||||||
- `earns_points` / `earns_coins`: belanja di outlet ini memberi EnakPoint / EnakCoin.
|
|
||||||
- Belum ada telepon, koordinat, atau jam buka; data itu belum disimpan di backend.
|
|
||||||
|
|
||||||
|
|
||||||
### 4.5 Riwayat order — `GET /customer/orders` dan `GET /customer/orders/:id`
|
|
||||||
|
|
||||||
Order milik customer yang login di semua outlet organisasinya, terbaru di atas. Order
|
|
||||||
hanya masuk ke sini bila kasir mengaitkannya ke customer.
|
|
||||||
|
|
||||||
`GET /api/v1/customer/orders?page=1&limit=20` (`limit` 1–100, default 20):
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"data": [
|
|
||||||
{
|
|
||||||
"id": "…",
|
|
||||||
"order_number": "ORD-0123",
|
|
||||||
"outlet_id": "…",
|
|
||||||
"outlet_name": "Gokuna 1",
|
|
||||||
"order_type": "dine_in",
|
|
||||||
"status": "completed",
|
|
||||||
"payment_status": "completed",
|
|
||||||
"total_amount": 99000,
|
|
||||||
"item_count": 2,
|
|
||||||
"is_void": false,
|
|
||||||
"is_refund": false,
|
|
||||||
"points_earned": 865,
|
|
||||||
"coins_earned": 3,
|
|
||||||
"created_at": "2026-09-30T12:01:00Z"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"pagination": { "page": 1, "limit": 20, "total_count": 42, "total_pages": 3 }
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
`GET /api/v1/customer/orders/{id}` mengembalikan field yang sama, ditambah:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"table_number": "A3",
|
|
||||||
"subtotal": 90000,
|
|
||||||
"discount_amount": 0,
|
|
||||||
"tax_amount": 9000,
|
|
||||||
"refund_amount": 0,
|
|
||||||
"items": [
|
|
||||||
{
|
|
||||||
"id": "…",
|
|
||||||
"product_id": "…",
|
|
||||||
"product_name": "Kopi Susu",
|
|
||||||
"variant_name": "Large",
|
|
||||||
"quantity": 2,
|
|
||||||
"unit_price": 25000,
|
|
||||||
"total_price": 50000,
|
|
||||||
"refund_quantity": 0,
|
|
||||||
"modifiers": [],
|
|
||||||
"status": "completed"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "…",
|
|
||||||
"product_id": "…",
|
|
||||||
"product_name": "Ikan Tude",
|
|
||||||
"variant_name": null,
|
|
||||||
"quantity": 1,
|
|
||||||
"weight": 4.2,
|
|
||||||
"unit_name": "ons",
|
|
||||||
"unit_price": 4500,
|
|
||||||
"total_price": 18900,
|
|
||||||
"refund_quantity": 0,
|
|
||||||
"modifiers": [],
|
|
||||||
"status": "completed"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"payments": [
|
|
||||||
{ "id": "…", "method_name": "Cash", "method_type": "cash", "amount": 99000, "status": "completed", "refund_amount": 0, "created_at": "…" }
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
- Order customer lain atau yang tidak ada → `404`.
|
|
||||||
- `points_earned` / `coins_earned`: yang didapat dari order ini; 0 bila tidak ada.
|
|
||||||
- Item timbangan membawa `weight` dan `unit_name`; tampilkan "1 × 4,2 ons".
|
|
||||||
- Order yang `is_void` atau `is_refund` tetap tampil, beri label "Dibatalkan" /
|
|
||||||
"Direfund".
|
|
||||||
|
|
||||||
|
|
||||||
## 5. Notifikasi push (FCM)
|
|
||||||
|
|
||||||
### 5.1 Registrasi device
|
|
||||||
|
|
||||||
Setelah login berhasil **dan** setiap kali FCM memberi token baru (`onTokenRefresh`):
|
|
||||||
|
|
||||||
`PUT /api/v1/customer/devices`
|
|
||||||
|
|
||||||
```json
|
|
||||||
{ "device_id": "<id unik & stabil per instalasi>", "fcm_token": "<token FCM>", "platform": "android", "app_version": "2.4.0" }
|
|
||||||
```
|
|
||||||
|
|
||||||
- `device_id` wajib, stabil untuk satu instalasi (simpan di secure storage).
|
|
||||||
- `platform`: `android`, `ios`, atau `web`.
|
|
||||||
- Saat **logout**, panggil `DELETE /api/v1/customer/devices/{device_id}` sebelum
|
|
||||||
menghapus token login, supaya HP itu tidak lagi menerima notifikasi akun ini.
|
|
||||||
|
|
||||||
Tanpa registrasi ini, customer tidak menerima push apa pun.
|
|
||||||
|
|
||||||
### 5.2 Tipe push
|
|
||||||
|
|
||||||
Semua nilai di `data` berupa string.
|
|
||||||
|
|
||||||
| `data.type` | Kapan | Isi `data` lain | Aksi saat di-tap |
|
|
||||||
|---|---|---|---|
|
|
||||||
| `WALLET_TRANSFER_IN` | Menerima transfer | `transaction_id`, `group_id`, `currency`, `amount` | Buka riwayat, sorot transaksi itu |
|
|
||||||
| `WALLET_EXPIRING` | Beberapa hari sebelum saldo hangus | `currency`, `amount`, `expiry_date` | Buka layar kedaluwarsa (§4.3) |
|
|
||||||
| `WALLET_EXPIRED` | Saldo baru saja hangus | `currency`, `amount` | Buka riwayat |
|
|
||||||
| `PIN_LOCKED` | PIN terkunci setelah 5 kali salah | `locked_until` (RFC3339 UTC) | Buka layar lupa PIN (§6.4) |
|
|
||||||
|
|
||||||
Saat app terbuka dan menerima push wallet, muat ulang beranda.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 6. PIN
|
|
||||||
|
|
||||||
### 6.1 Kapan diminta
|
|
||||||
|
|
||||||
Jangan minta PIN saat registrasi. Minta saat customer **pertama kali** melakukan aksi
|
|
||||||
yang butuh PIN. Cek dengan:
|
|
||||||
|
|
||||||
`GET /api/v1/customer/pin/status` → `{ "has_pin": false, "locked_until": null, "transfer_blocked_until": null }`
|
|
||||||
|
|
||||||
Bila `has_pin: false`, arahkan ke alur buat PIN, lalu kembali ke aksi semula.
|
|
||||||
|
|
||||||
### 6.2 Buat PIN
|
|
||||||
|
|
||||||
1. `POST /api/v1/customer/pin/otp` dengan `{ "purpose": "pin_setup" }`.
|
|
||||||
Response: `{ "purpose": "pin_setup", "otp_token": "…", "expires_at": "…" }`.
|
|
||||||
OTP dikirim ke WhatsApp customer.
|
|
||||||
2. Customer memasukkan kode OTP, lalu PIN dua kali.
|
|
||||||
3. `POST /api/v1/customer/pin` dengan
|
|
||||||
`{ "otp_token": "…", "otp_code": "123456", "pin": "482913", "confirm_pin": "482913" }`.
|
|
||||||
Response: status PIN.
|
|
||||||
|
|
||||||
Validasi di app sebelum kirim (server juga memeriksa, jawab `304`):
|
|
||||||
- Tepat 6 digit angka, dan konfirmasi sama.
|
|
||||||
- Bukan satu digit berulang (`111111`).
|
|
||||||
- Bukan berurutan naik/turun (`123456`, `654321`).
|
|
||||||
- Bukan tanggal lahir customer (`DDMMYY` atau `YYMMDD`).
|
|
||||||
|
|
||||||
Minta OTP lagi terlalu cepat → `429`: tampilkan hitung mundur.
|
|
||||||
|
|
||||||
### 6.3 Ganti PIN
|
|
||||||
|
|
||||||
`PUT /api/v1/customer/pin` dengan `{ "old_pin": "…", "pin": "…", "confirm_pin": "…" }`.
|
|
||||||
|
|
||||||
### 6.4 Lupa PIN
|
|
||||||
|
|
||||||
1. `POST /customer/pin/otp` dengan `{ "purpose": "pin_reset" }`.
|
|
||||||
2. `POST /customer/pin/reset` dengan `{ "otp_token", "otp_code", "pin", "confirm_pin" }`.
|
|
||||||
|
|
||||||
Reset juga membuka PIN yang terkunci. Setelah reset, **transfer keluar ditahan 24 jam**;
|
|
||||||
tukar tetap bisa. Beri tahu customer hal ini di layar sukses.
|
|
||||||
|
|
||||||
### 6.5 Menangani error PIN
|
|
||||||
|
|
||||||
Semua endpoint yang menerima `pin` bisa menjawab error PIN. Pada error ini **`data`
|
|
||||||
tidak `null`**:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{ "success": false, "data": { "code": "PIN_INVALID", "remaining_attempts": 3 }, "errors": [ … ] }
|
|
||||||
```
|
|
||||||
|
|
||||||
| `data.code` | Field tambahan | Tampilan |
|
|
||||||
|---|---|---|
|
|
||||||
| `PIN_NOT_SET` | – | Buka alur buat PIN (§6.2) |
|
|
||||||
| `PIN_INVALID` | `remaining_attempts` | "PIN salah, sisa {n} percobaan." Kosongkan input PIN |
|
|
||||||
| `PIN_LOCKED` | `locked_until` | "PIN terkunci sampai {jam}." Tombol "Lupa PIN" |
|
|
||||||
| `TRANSFER_BLOCKED` | `transfer_blocked_until` | "Transfer bisa dilakukan lagi pada {waktu}." |
|
|
||||||
|
|
||||||
5 kali salah berturut-turut mengunci PIN 30 menit; selama terkunci PIN yang benar pun
|
|
||||||
ditolak. Penghitung ada di server, jadi jangan membuat penghitung sendiri di app.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 7. Tukar dan transfer
|
|
||||||
|
|
||||||
### 7.1 Tukar EnakCoin → EnakPoint
|
|
||||||
|
|
||||||
1. Customer mengetik jumlah EnakCoin. Panggil preview (debounce saat mengetik):
|
|
||||||
|
|
||||||
`GET /api/v1/customer/wallet/exchange/preview?coins=30`
|
|
||||||
|
|
||||||
```json
|
|
||||||
{ "coin_amount": 10, "point_amount": 3, "coin_balance": 35, "coins": 30, "points": 9, "valid": true }
|
|
||||||
```
|
|
||||||
|
|
||||||
- Kurs: `coin_amount` EnakCoin = `point_amount` EnakPoint. Tampilkan "10 EnakCoin =
|
|
||||||
3 EnakPoint".
|
|
||||||
- Bila `valid: false`, tampilkan `reason` sebagai alasan dan nonaktifkan tombol. Jumlah
|
|
||||||
harus kelipatan `coin_amount`.
|
|
||||||
- Tampilkan "Kamu akan mendapat {points} EnakPoint".
|
|
||||||
|
|
||||||
2. Konfirmasi (tukar tidak bisa dibatalkan) → minta PIN →
|
|
||||||
|
|
||||||
`POST /api/v1/customer/wallet/exchange` + header `Idempotency-Key`
|
|
||||||
|
|
||||||
```json
|
|
||||||
{ "coins": 30, "pin": "482913" }
|
|
||||||
```
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"group_id": "…",
|
|
||||||
"coins": 30,
|
|
||||||
"points": 9,
|
|
||||||
"coin_amount": 10,
|
|
||||||
"point_amount": 3,
|
|
||||||
"lots": [{ "amount": 9, "expires_at": "2026-12-31T23:59:59+07:00" }],
|
|
||||||
"coin_balance": 5,
|
|
||||||
"point_balance": 9,
|
|
||||||
"replayed": false
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
3. Layar sukses: saldo baru, dan bila `lots[].expires_at` ada, "EnakPoint ini berlaku
|
|
||||||
sampai {tanggal}".
|
|
||||||
|
|
||||||
### 7.2 Transfer
|
|
||||||
|
|
||||||
1. Pilih mata uang (EnakPoint / EnakCoin), isi nomor HP penerima dan jumlah.
|
|
||||||
2. Cek penerima:
|
|
||||||
|
|
||||||
`GET /api/v1/customer/wallet/transfer/recipient?phone=081234561234`
|
|
||||||
|
|
||||||
```json
|
|
||||||
{ "name": "Bu*** Sa***", "phone_number": "08**-****-1234" }
|
|
||||||
```
|
|
||||||
|
|
||||||
| Hasil | Tampilan |
|
|
||||||
|---|---|
|
|
||||||
| Sukses | "Kirim ke Bu*** Sa*** (08**-****-1234)?" |
|
|
||||||
| `404` | "Nomor ini tidak terdaftar" |
|
|
||||||
| `304` | "Tidak bisa mengirim ke nomor ini" (diri sendiri, akun nonaktif) |
|
|
||||||
|
|
||||||
3. Konfirmasi (transfer final, tidak bisa dibatalkan) → minta PIN →
|
|
||||||
|
|
||||||
`POST /api/v1/customer/wallet/transfer` + header `Idempotency-Key`
|
|
||||||
|
|
||||||
```json
|
|
||||||
{ "currency": "POINT", "amount": 120, "recipient_phone": "081234561234", "pin": "482913" }
|
|
||||||
```
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"group_id": "…",
|
|
||||||
"currency": "POINT",
|
|
||||||
"amount": 120,
|
|
||||||
"recipient": { "name": "Bu*** Sa***", "phone_number": "08**-****-1234" },
|
|
||||||
"lots": [
|
|
||||||
{ "amount": 100, "expires_at": "2026-12-31T23:59:59+07:00" },
|
|
||||||
{ "amount": 20, "expires_at": null }
|
|
||||||
],
|
|
||||||
"balance": 30,
|
|
||||||
"replayed": false
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
4. Layar sukses: saldo tersisa (`balance`). Bila ada `lots[].expires_at`, tampilkan
|
|
||||||
"Saldo yang dikirim berlaku sampai {tanggal}" (tanggal kedaluwarsa ikut terbawa ke
|
|
||||||
penerima).
|
|
||||||
|
|
||||||
Penolakan `304` yang mungkin: transfer dimatikan owner, di bawah minimal, di atas
|
|
||||||
maksimal per transaksi, melewati batas harian (reset tengah malam WIB), saldo tidak
|
|
||||||
cukup. Tampilkan pesan umum "Transfer tidak bisa diproses" plus alasan yang sesuai
|
|
||||||
bila bisa dikenali. Bila kena `TRANSFER_BLOCKED`, ikuti §6.5.
|
|
||||||
|
|
||||||
Penerima mendapat push `WALLET_TRANSFER_IN`.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 8. Game (memakai EnakCoin)
|
|
||||||
|
|
||||||
`POST /api/v1/customer/spin`, `GET /customer/games`, dan `GET /customer/ferris-wheel`
|
|
||||||
sudah dihapus. Semua game, termasuk spin, dimainkan lewat EnakGame. Tanpa PIN.
|
|
||||||
|
|
||||||
1. `GET /api/v1/customer/enakgame/games`: daftar game dengan `entry_cost` (EnakCoin per
|
|
||||||
main). Tampilkan biaya sebelum main, dan nonaktifkan tombol bila `coin_balance`
|
|
||||||
kurang. Spin punya `prizes` untuk menggambar roda.
|
|
||||||
2. `POST /api/v1/customer/enakgame/sessions` dengan `{ "game_id": "…" }` dan header
|
|
||||||
`Idempotency-Key` (satu key per tap; retry memakai key yang sama). Response berisi
|
|
||||||
`session_id` dan `coin_balance` setelah dipotong.
|
|
||||||
3. `POST /api/v1/customer/enakgame/sessions/:id/complete` dengan hasil main (`score`
|
|
||||||
atau `outcome`; spin cukup `{}`). Server yang menentukan hadiah: perbarui saldo dari
|
|
||||||
`coin_balance`, tampilkan `reward_total`, dan untuk spin hentikan roda di `prize.entry`.
|
|
||||||
|
|
||||||
Rincian spin ada di [`enakgame-spin.md`](./enakgame-spin.md).
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 9. Yang sudah dihapus / deprecated
|
|
||||||
|
|
||||||
Sudah **dihapus** dari API (jangan dipanggil, akan error / tidak ada):
|
|
||||||
|
|
||||||
| Lama | Pengganti |
|
|
||||||
|---|---|
|
|
||||||
| `GET /customer/tokens` | `GET /customer/wallet` → `coin_balance` |
|
|
||||||
| `total_tokens`, `tokens_history` | `coin_balance`, `GET /customer/wallet/transactions?currency=COIN` |
|
|
||||||
| `token_used`, `tokens_remaining` di response game | `coins_used`, `coins_remaining` |
|
|
||||||
| `POST /customer/wallet/payment-code` | Tidak ada; EnakPoint tidak bisa untuk bayar |
|
|
||||||
| `POST /customer/orders/:id/pay-with-points` | Tidak ada; EnakPoint tidak bisa untuk bayar |
|
|
||||||
| `GET /orders/:id/point-payment/preview` (POS) | Tidak ada; EnakPoint tidak bisa untuk bayar |
|
|
||||||
| `accepts_point_payment` di `GET /customer/outlets` | – |
|
|
||||||
| `points_used`, `point_value` di `payments` pada `GET /customer/orders/:id` | – |
|
|
||||||
| Tipe mutasi `PAYMENT`, `PAYMENT_REFUND` di riwayat | Tidak ditulis lagi |
|
|
||||||
|
|
||||||
Masih ada tapi **deprecated** (akan dihapus, jangan dipakai di kode baru):
|
|
||||||
|
|
||||||
| Lama | Pengganti |
|
|
||||||
|---|---|
|
|
||||||
| `GET /customer/points` | `GET /customer/wallet` → `point_balance` |
|
|
||||||
| `total_points`, `points_history`, `last_updated` di `/customer/wallet` | `point_balance`, `recent_transactions` |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 10. Checklist selesai
|
|
||||||
|
|
||||||
- [ ] Beranda menampilkan saldo EnakPoint ("setara potongan Rp …"), EnakCoin, dan banner kedaluwarsa terdekat.
|
|
||||||
- [ ] Riwayat dengan tab per mata uang, filter tipe/tanggal, infinite scroll, label tipe sesuai §4.2.
|
|
||||||
- [ ] Layar saldo akan kedaluwarsa.
|
|
||||||
- [ ] Registrasi device FCM setelah login dan saat token berganti; unregister saat logout.
|
|
||||||
- [ ] Penanganan tap untuk keempat tipe push.
|
|
||||||
- [ ] PIN diminta hanya saat aksi yang membutuhkan; alur buat, ganti, dan lupa PIN lewat OTP.
|
|
||||||
- [ ] Keempat error PIN ditangani di semua layar yang meminta PIN.
|
|
||||||
- [ ] Tukar dengan preview, kelipatan kurs, konfirmasi, `Idempotency-Key`, retry dengan key sama.
|
|
||||||
- [ ] Transfer dengan cek penerima tersamar, konfirmasi, `Idempotency-Key`, retry dengan key sama.
|
|
||||||
- [ ] Game memakai `coins_used` / `coins_remaining` dan menampilkan biaya per game.
|
|
||||||
- [ ] Riwayat order dengan pagination dan layar detail (item, pembayaran, EnakPoint/EnakCoin yang didapat).
|
|
||||||
- [ ] Tidak ada pemakaian endpoint atau field di §9.
|
|
||||||
- [ ] PIN tidak pernah disimpan, di-log, atau dikirim ke analytics.
|
|
||||||
+13
-5
@@ -636,7 +636,7 @@ menanganinya, dan complete di §7.2 langkah 4 menangani yang lebih cepat.
|
|||||||
### 7.4 Redemption voucher internal (`STATIC`, `CODE_POOL`)
|
### 7.4 Redemption voucher internal (`STATIC`, `CODE_POOL`)
|
||||||
|
|
||||||
```
|
```
|
||||||
POST /customer/enakgame/vouchers/:id/redeem { pin } Idempotency-Key: <≤50 char>
|
POST /customer/vouchers/:id/redeem { pin } Idempotency-Key: <≤50 char>
|
||||||
```
|
```
|
||||||
|
|
||||||
Satu transaksi, sehingga state `RESERVED` tidak diperlukan:
|
Satu transaksi, sehingga state `RESERVED` tidak diperlukan:
|
||||||
@@ -843,12 +843,20 @@ tambahkan snapshot harian, bukan cache yang di-invalidate.
|
|||||||
| `POST` | `/sessions/:id/complete` | §7.2. Idempotent tanpa header |
|
| `POST` | `/sessions/:id/complete` | §7.2. Idempotent tanpa header |
|
||||||
| `GET` | `/sessions/:id` | Status dan hasil |
|
| `GET` | `/sessions/:id` | Status dan hasil |
|
||||||
| `GET` | `/sessions` | Riwayat main |
|
| `GET` | `/sessions` | Riwayat main |
|
||||||
| `GET` | `/vouchers` | Katalog `ACTIVE` + stok tersedia |
|
|
||||||
| `POST` | `/vouchers/:id/redeem` | §7.4 / §7.5. Wajib `Idempotency-Key` + PIN |
|
|
||||||
| `GET` | `/redemptions` | Voucher milik customer, termasuk kode |
|
|
||||||
|
|
||||||
Prefix `/enakgame` dipakai karena `/customer/games` sudah dipakai alur spin lama.
|
Prefix `/enakgame` dipakai karena `/customer/games` sudah dipakai alur spin lama.
|
||||||
|
|
||||||
|
### Voucher customer (`/api/v1/customer/vouchers`, `ValidateCustomerToken`)
|
||||||
|
|
||||||
|
Voucher adalah tempat memakai EnakPoint dari mana pun asalnya, bukan bagian dari game,
|
||||||
|
jadi tidak di bawah `/enakgame` (diubah 2026-10-08).
|
||||||
|
|
||||||
|
| Method | Path | Catatan |
|
||||||
|
|---|---|---|
|
||||||
|
| `GET` | `/vouchers` | Katalog `ACTIVE` + stok tersedia |
|
||||||
|
| `POST` | `/vouchers/:id/redeem` | §7.4 / §7.5. Wajib `Idempotency-Key` + PIN |
|
||||||
|
| `GET` | `/vouchers/redemptions` | Voucher milik customer, termasuk kode |
|
||||||
|
|
||||||
### Admin (`/api/v1/marketing/enakgame`, `RequireAdminOrManager`)
|
### Admin (`/api/v1/marketing/enakgame`, `RequireAdminOrManager`)
|
||||||
|
|
||||||
| Resource | Endpoint |
|
| Resource | Endpoint |
|
||||||
@@ -858,7 +866,7 @@ Prefix `/enakgame` dipakai karena `/customer/games` sudah dipakai alur spin lama
|
|||||||
| Events | CRUD, `PUT /:id/status` |
|
| Events | CRUD, `PUT /:id/status` |
|
||||||
| Budgets | CRUD, `GET /:id/metrics`, `GET /:id/recommendation`, `POST /:id/recommendation/accept` |
|
| Budgets | CRUD, `GET /:id/metrics`, `GET /:id/recommendation`, `POST /:id/recommendation/accept` |
|
||||||
| Analytics | `GET /analytics/games?from=&to=&game_id=`, `GET /analytics/economy?from=&to=` (tanggal Asia/Jakarta, maks 366 hari) |
|
| Analytics | `GET /analytics/games?from=&to=&game_id=`, `GET /analytics/economy?from=&to=` (tanggal Asia/Jakarta, maks 366 hari) |
|
||||||
| Vouchers | CRUD, `POST /:id/codes` (impor CSV), `GET /:id/codes` |
|
| Vouchers | Di `/api/v1/marketing/vouchers`, bukan di bawah `/enakgame`: CRUD, `PUT /:id/status`, `POST /:id/codes` (impor CSV), `GET /:id/codes` |
|
||||||
| Redemptions | `GET` list, `GET /:id` dengan atribusi cost |
|
| Redemptions | `GET` list, `GET /:id` dengan atribusi cost |
|
||||||
| Sessions | `GET` list + filter `flagged` |
|
| Sessions | `GET` list + filter `flagged` |
|
||||||
| Settings | Lewat endpoint loyalty settings yang ada, dengan key baru (§5.10) |
|
| Settings | Lewat endpoint loyalty settings yang ada, dengan key baru (§5.10) |
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ type StartGameSessionRequest struct {
|
|||||||
GameID uuid.UUID `json:"game_id" binding:"required"`
|
GameID uuid.UUID `json:"game_id" binding:"required"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// RedeemVoucherRequest is POST /customer/enakgame/vouchers/:id/redeem (§7.4). The
|
// RedeemVoucherRequest is POST /customer/vouchers/:id/redeem (§7.4). The
|
||||||
// Idempotency-Key header is required.
|
// Idempotency-Key header is required.
|
||||||
type RedeemVoucherRequest struct {
|
type RedeemVoucherRequest struct {
|
||||||
Pin string `json:"pin" binding:"required"`
|
Pin string `json:"pin" binding:"required"`
|
||||||
|
|||||||
@@ -285,7 +285,7 @@ func (h *EnakGameAdminHandler) EconomyAnalytics(c *gin.Context) {
|
|||||||
util.HandleResponse(c.Writer, c.Request, h.service.EconomyAnalytics(ctx, appcontext.FromGinContext(ctx), q), method)
|
util.HandleResponse(c.Writer, c.Request, h.service.EconomyAnalytics(ctx, appcontext.FromGinContext(ctx), q), method)
|
||||||
}
|
}
|
||||||
|
|
||||||
// CreateVoucher is POST /marketing/enakgame/vouchers.
|
// CreateVoucher is POST /marketing/vouchers.
|
||||||
func (h *EnakGameAdminHandler) CreateVoucher(c *gin.Context) {
|
func (h *EnakGameAdminHandler) CreateVoucher(c *gin.Context) {
|
||||||
const method = "EnakGameAdminHandler::CreateVoucher"
|
const method = "EnakGameAdminHandler::CreateVoucher"
|
||||||
body, ok := rawBody(c, method)
|
body, ok := rawBody(c, method)
|
||||||
@@ -296,7 +296,7 @@ func (h *EnakGameAdminHandler) CreateVoucher(c *gin.Context) {
|
|||||||
util.HandleResponse(c.Writer, c.Request, h.service.CreateVoucher(ctx, appcontext.FromGinContext(ctx), body), method)
|
util.HandleResponse(c.Writer, c.Request, h.service.CreateVoucher(ctx, appcontext.FromGinContext(ctx), body), method)
|
||||||
}
|
}
|
||||||
|
|
||||||
// ListVouchers is GET /marketing/enakgame/vouchers?status=&search=&page=&limit=.
|
// ListVouchers is GET /marketing/vouchers?status=&search=&page=&limit=.
|
||||||
func (h *EnakGameAdminHandler) ListVouchers(c *gin.Context) {
|
func (h *EnakGameAdminHandler) ListVouchers(c *gin.Context) {
|
||||||
const method = "EnakGameAdminHandler::ListVouchers"
|
const method = "EnakGameAdminHandler::ListVouchers"
|
||||||
var q models.VoucherListQuery
|
var q models.VoucherListQuery
|
||||||
@@ -307,7 +307,7 @@ func (h *EnakGameAdminHandler) ListVouchers(c *gin.Context) {
|
|||||||
util.HandleResponse(c.Writer, c.Request, h.service.ListVouchers(ctx, appcontext.FromGinContext(ctx), q), method)
|
util.HandleResponse(c.Writer, c.Request, h.service.ListVouchers(ctx, appcontext.FromGinContext(ctx), q), method)
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetVoucher is GET /marketing/enakgame/vouchers/:id.
|
// GetVoucher is GET /marketing/vouchers/:id.
|
||||||
func (h *EnakGameAdminHandler) GetVoucher(c *gin.Context) {
|
func (h *EnakGameAdminHandler) GetVoucher(c *gin.Context) {
|
||||||
const method = "EnakGameAdminHandler::GetVoucher"
|
const method = "EnakGameAdminHandler::GetVoucher"
|
||||||
id, ok := pathID(c, "id", method)
|
id, ok := pathID(c, "id", method)
|
||||||
@@ -318,7 +318,7 @@ func (h *EnakGameAdminHandler) GetVoucher(c *gin.Context) {
|
|||||||
util.HandleResponse(c.Writer, c.Request, h.service.GetVoucher(ctx, appcontext.FromGinContext(ctx), id), method)
|
util.HandleResponse(c.Writer, c.Request, h.service.GetVoucher(ctx, appcontext.FromGinContext(ctx), id), method)
|
||||||
}
|
}
|
||||||
|
|
||||||
// UpdateVoucher is PUT /marketing/enakgame/vouchers/:id.
|
// UpdateVoucher is PUT /marketing/vouchers/:id.
|
||||||
func (h *EnakGameAdminHandler) UpdateVoucher(c *gin.Context) {
|
func (h *EnakGameAdminHandler) UpdateVoucher(c *gin.Context) {
|
||||||
const method = "EnakGameAdminHandler::UpdateVoucher"
|
const method = "EnakGameAdminHandler::UpdateVoucher"
|
||||||
id, ok := pathID(c, "id", method)
|
id, ok := pathID(c, "id", method)
|
||||||
@@ -333,7 +333,7 @@ func (h *EnakGameAdminHandler) UpdateVoucher(c *gin.Context) {
|
|||||||
util.HandleResponse(c.Writer, c.Request, h.service.UpdateVoucher(ctx, appcontext.FromGinContext(ctx), id, body), method)
|
util.HandleResponse(c.Writer, c.Request, h.service.UpdateVoucher(ctx, appcontext.FromGinContext(ctx), id, body), method)
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetVoucherStatus is PUT /marketing/enakgame/vouchers/:id/status.
|
// SetVoucherStatus is PUT /marketing/vouchers/:id/status.
|
||||||
func (h *EnakGameAdminHandler) SetVoucherStatus(c *gin.Context) {
|
func (h *EnakGameAdminHandler) SetVoucherStatus(c *gin.Context) {
|
||||||
const method = "EnakGameAdminHandler::SetVoucherStatus"
|
const method = "EnakGameAdminHandler::SetVoucherStatus"
|
||||||
id, ok := pathID(c, "id", method)
|
id, ok := pathID(c, "id", method)
|
||||||
@@ -348,7 +348,7 @@ func (h *EnakGameAdminHandler) SetVoucherStatus(c *gin.Context) {
|
|||||||
util.HandleResponse(c.Writer, c.Request, h.service.SetVoucherStatus(ctx, appcontext.FromGinContext(ctx), id, body), method)
|
util.HandleResponse(c.Writer, c.Request, h.service.SetVoucherStatus(ctx, appcontext.FromGinContext(ctx), id, body), method)
|
||||||
}
|
}
|
||||||
|
|
||||||
// ImportVoucherCodes is POST /marketing/enakgame/vouchers/:id/codes, with the CSV as
|
// ImportVoucherCodes is POST /marketing/vouchers/:id/codes, with the CSV as
|
||||||
// a multipart file named "file" or as the request body.
|
// a multipart file named "file" or as the request body.
|
||||||
func (h *EnakGameAdminHandler) ImportVoucherCodes(c *gin.Context) {
|
func (h *EnakGameAdminHandler) ImportVoucherCodes(c *gin.Context) {
|
||||||
const method = "EnakGameAdminHandler::ImportVoucherCodes"
|
const method = "EnakGameAdminHandler::ImportVoucherCodes"
|
||||||
@@ -379,7 +379,7 @@ func (h *EnakGameAdminHandler) ImportVoucherCodes(c *gin.Context) {
|
|||||||
util.HandleResponse(c.Writer, c.Request, h.service.ImportVoucherCodes(ctx, appcontext.FromGinContext(ctx), id, data), method)
|
util.HandleResponse(c.Writer, c.Request, h.service.ImportVoucherCodes(ctx, appcontext.FromGinContext(ctx), id, data), method)
|
||||||
}
|
}
|
||||||
|
|
||||||
// ListVoucherCodes is GET /marketing/enakgame/vouchers/:id/codes?status=&page=&limit=.
|
// ListVoucherCodes is GET /marketing/vouchers/:id/codes?status=&page=&limit=.
|
||||||
func (h *EnakGameAdminHandler) ListVoucherCodes(c *gin.Context) {
|
func (h *EnakGameAdminHandler) ListVoucherCodes(c *gin.Context) {
|
||||||
const method = "EnakGameAdminHandler::ListVoucherCodes"
|
const method = "EnakGameAdminHandler::ListVoucherCodes"
|
||||||
id, ok := pathID(c, "id", method)
|
id, ok := pathID(c, "id", method)
|
||||||
|
|||||||
@@ -106,7 +106,7 @@ func (h *EnakGameCustomerHandler) CompleteSession(c *gin.Context) {
|
|||||||
util.HandleResponse(c.Writer, c.Request, h.service.CompleteSession(c.Request.Context(), customerID, id, in), method)
|
util.HandleResponse(c.Writer, c.Request, h.service.CompleteSession(c.Request.Context(), customerID, id, in), method)
|
||||||
}
|
}
|
||||||
|
|
||||||
// ListVouchers is GET /customer/enakgame/vouchers.
|
// ListVouchers is GET /customer/vouchers.
|
||||||
func (h *EnakGameCustomerHandler) ListVouchers(c *gin.Context) {
|
func (h *EnakGameCustomerHandler) ListVouchers(c *gin.Context) {
|
||||||
const method = "EnakGameCustomerHandler::ListVouchers"
|
const method = "EnakGameCustomerHandler::ListVouchers"
|
||||||
customerID, ok := customerIDFromGin(c, method)
|
customerID, ok := customerIDFromGin(c, method)
|
||||||
@@ -116,7 +116,7 @@ func (h *EnakGameCustomerHandler) ListVouchers(c *gin.Context) {
|
|||||||
util.HandleResponse(c.Writer, c.Request, h.service.ListVouchers(c.Request.Context(), customerID), method)
|
util.HandleResponse(c.Writer, c.Request, h.service.ListVouchers(c.Request.Context(), customerID), method)
|
||||||
}
|
}
|
||||||
|
|
||||||
// RedeemVoucher is POST /customer/enakgame/vouchers/:id/redeem. It requires the PIN
|
// RedeemVoucher is POST /customer/vouchers/:id/redeem. It requires the PIN
|
||||||
// and Idempotency-Key; the body holds the PIN, so it is never logged.
|
// and Idempotency-Key; the body holds the PIN, so it is never logged.
|
||||||
func (h *EnakGameCustomerHandler) RedeemVoucher(c *gin.Context) {
|
func (h *EnakGameCustomerHandler) RedeemVoucher(c *gin.Context) {
|
||||||
const method = "EnakGameCustomerHandler::RedeemVoucher"
|
const method = "EnakGameCustomerHandler::RedeemVoucher"
|
||||||
@@ -135,7 +135,7 @@ func (h *EnakGameCustomerHandler) RedeemVoucher(c *gin.Context) {
|
|||||||
util.HandleResponse(c.Writer, c.Request, h.service.RedeemVoucher(c.Request.Context(), customerID, id, &req, idempotencyKey(c), pinRequestInfo(c)), method)
|
util.HandleResponse(c.Writer, c.Request, h.service.RedeemVoucher(c.Request.Context(), customerID, id, &req, idempotencyKey(c), pinRequestInfo(c)), method)
|
||||||
}
|
}
|
||||||
|
|
||||||
// ListRedemptions is GET /customer/enakgame/redemptions?page=&limit=.
|
// ListRedemptions is GET /customer/vouchers/redemptions?page=&limit=.
|
||||||
func (h *EnakGameCustomerHandler) ListRedemptions(c *gin.Context) {
|
func (h *EnakGameCustomerHandler) ListRedemptions(c *gin.Context) {
|
||||||
const method = "EnakGameCustomerHandler::ListRedemptions"
|
const method = "EnakGameCustomerHandler::ListRedemptions"
|
||||||
customerID, ok := customerIDFromGin(c, method)
|
customerID, ok := customerIDFromGin(c, method)
|
||||||
|
|||||||
@@ -285,7 +285,7 @@ func TestEnakGameVoucherEndpoints_AgainstPostgres(t *testing.T) {
|
|||||||
router := gin.New()
|
router := gin.New()
|
||||||
for prefix, role := range map[string]string{"/manager": "manager", "/purchasing": "purchasing"} {
|
for prefix, role := range map[string]string{"/manager": "manager", "/purchasing": "purchasing"} {
|
||||||
role := role
|
role := role
|
||||||
g := router.Group(prefix+"/enakgame", func(c *gin.Context) {
|
g := router.Group(prefix, func(c *gin.Context) {
|
||||||
ctx := context.WithValue(c.Request.Context(), appcontext.OrganizationIDKey, org.String())
|
ctx := context.WithValue(c.Request.Context(), appcontext.OrganizationIDKey, org.String())
|
||||||
ctx = context.WithValue(ctx, appcontext.UserIDKey, admin.String())
|
ctx = context.WithValue(ctx, appcontext.UserIDKey, admin.String())
|
||||||
ctx = context.WithValue(ctx, appcontext.UserRoleKey, role)
|
ctx = context.WithValue(ctx, appcontext.UserRoleKey, role)
|
||||||
@@ -296,10 +296,10 @@ func TestEnakGameVoucherEndpoints_AgainstPostgres(t *testing.T) {
|
|||||||
g.POST("/vouchers/:id/codes", auth.RequireLoyaltyManager(), adminHandler.ImportVoucherCodes)
|
g.POST("/vouchers/:id/codes", auth.RequireLoyaltyManager(), adminHandler.ImportVoucherCodes)
|
||||||
g.GET("/vouchers/:id/codes", adminHandler.ListVoucherCodes)
|
g.GET("/vouchers/:id/codes", adminHandler.ListVoucherCodes)
|
||||||
}
|
}
|
||||||
c := router.Group("/customer/enakgame", func(c *gin.Context) { c.Set("customer_id", customer.String()) })
|
c := router.Group("/customer", func(c *gin.Context) { c.Set("customer_id", customer.String()) })
|
||||||
c.GET("/vouchers", customerHandler.ListVouchers)
|
c.GET("/vouchers", customerHandler.ListVouchers)
|
||||||
c.POST("/vouchers/:id/redeem", customerHandler.RedeemVoucher)
|
c.POST("/vouchers/:id/redeem", customerHandler.RedeemVoucher)
|
||||||
c.GET("/redemptions", customerHandler.ListRedemptions)
|
c.GET("/vouchers/redemptions", customerHandler.ListRedemptions)
|
||||||
|
|
||||||
send := func(req *http.Request) (int, map[string]any) {
|
send := func(req *http.Request) (int, map[string]any) {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
@@ -320,12 +320,12 @@ func TestEnakGameVoucherEndpoints_AgainstPostgres(t *testing.T) {
|
|||||||
data := func(body map[string]any) map[string]any { return body["data"].(map[string]any) }
|
data := func(body map[string]any) map[string]any { return body["data"].(map[string]any) }
|
||||||
|
|
||||||
voucher := `{"name": "Kopi", "voucher_type": "FREE_ITEM", "face_value": 20000, "point_cost": 15000, "stock_mode": "CODE_POOL", "status": "ACTIVE"}`
|
voucher := `{"name": "Kopi", "voucher_type": "FREE_ITEM", "face_value": 20000, "point_cost": 15000, "stock_mode": "CODE_POOL", "status": "ACTIVE"}`
|
||||||
status, _ := call(http.MethodPost, "/purchasing/enakgame/vouchers", voucher)
|
status, _ := call(http.MethodPost, "/purchasing/vouchers", voucher)
|
||||||
assert.Equal(t, http.StatusForbidden, status)
|
assert.Equal(t, http.StatusForbidden, status)
|
||||||
status, body := call(http.MethodPost, "/manager/enakgame/vouchers", voucher)
|
status, body := call(http.MethodPost, "/manager/vouchers", voucher)
|
||||||
require.Equal(t, http.StatusOK, status, body)
|
require.Equal(t, http.StatusOK, status, body)
|
||||||
id := data(body)["id"].(string)
|
id := data(body)["id"].(string)
|
||||||
status, _ = call(http.MethodPut, "/manager/enakgame/vouchers/"+id, `{"stock_mode": "STATIC", "stock": 5}`)
|
status, _ = call(http.MethodPut, "/manager/vouchers/"+id, `{"stock_mode": "STATIC", "stock": 5}`)
|
||||||
assert.Equal(t, http.StatusBadRequest, status, "the stock mode stays")
|
assert.Equal(t, http.StatusBadRequest, status, "the stock mode stays")
|
||||||
|
|
||||||
// Codes as a multipart file, then the same as a plain body.
|
// Codes as a multipart file, then the same as a plain body.
|
||||||
@@ -335,25 +335,25 @@ func TestEnakGameVoucherEndpoints_AgainstPostgres(t *testing.T) {
|
|||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
_, _ = part.Write([]byte("code\nKOPI-1\nKOPI-2\n"))
|
_, _ = part.Write([]byte("code\nKOPI-1\nKOPI-2\n"))
|
||||||
require.NoError(t, w.Close())
|
require.NoError(t, w.Close())
|
||||||
req := httptest.NewRequest(http.MethodPost, "/manager/enakgame/vouchers/"+id+"/codes", &form)
|
req := httptest.NewRequest(http.MethodPost, "/manager/vouchers/"+id+"/codes", &form)
|
||||||
req.Header.Set("Content-Type", w.FormDataContentType())
|
req.Header.Set("Content-Type", w.FormDataContentType())
|
||||||
status, body = send(req)
|
status, body = send(req)
|
||||||
require.Equal(t, http.StatusOK, status, body)
|
require.Equal(t, http.StatusOK, status, body)
|
||||||
assert.EqualValues(t, 2, data(body)["imported"])
|
assert.EqualValues(t, 2, data(body)["imported"])
|
||||||
status, body = call(http.MethodPost, "/manager/enakgame/vouchers/"+id+"/codes", "KOPI-2\nKOPI-3\n", "Content-Type", "text/csv")
|
status, body = call(http.MethodPost, "/manager/vouchers/"+id+"/codes", "KOPI-2\nKOPI-3\n", "Content-Type", "text/csv")
|
||||||
require.Equal(t, http.StatusOK, status, body)
|
require.Equal(t, http.StatusOK, status, body)
|
||||||
assert.EqualValues(t, 1, data(body)["imported"])
|
assert.EqualValues(t, 1, data(body)["imported"])
|
||||||
assert.Equal(t, []any{"KOPI-2"}, data(body)["duplicates"])
|
assert.Equal(t, []any{"KOPI-2"}, data(body)["duplicates"])
|
||||||
status, body = call(http.MethodGet, "/manager/enakgame/vouchers/"+id+"/codes", "")
|
status, body = call(http.MethodGet, "/manager/vouchers/"+id+"/codes", "")
|
||||||
require.Equal(t, http.StatusOK, status, body)
|
require.Equal(t, http.StatusOK, status, body)
|
||||||
assert.Equal(t, map[string]any{"AVAILABLE": float64(3)}, data(body)["counts"])
|
assert.Equal(t, map[string]any{"AVAILABLE": float64(3)}, data(body)["counts"])
|
||||||
|
|
||||||
status, body = call(http.MethodGet, "/customer/enakgame/vouchers", "")
|
status, body = call(http.MethodGet, "/customer/vouchers", "")
|
||||||
require.Equal(t, http.StatusOK, status, body)
|
require.Equal(t, http.StatusOK, status, body)
|
||||||
require.Len(t, body["data"], 1)
|
require.Len(t, body["data"], 1)
|
||||||
assert.EqualValues(t, 3, body["data"].([]any)[0].(map[string]any)["available"])
|
assert.EqualValues(t, 3, body["data"].([]any)[0].(map[string]any)["available"])
|
||||||
|
|
||||||
redeem := "/customer/enakgame/vouchers/" + id + "/redeem"
|
redeem := "/customer/vouchers/" + id + "/redeem"
|
||||||
status, body = call(http.MethodPost, redeem, `{"pin": "482913"}`)
|
status, body = call(http.MethodPost, redeem, `{"pin": "482913"}`)
|
||||||
assert.Equal(t, http.StatusBadRequest, status, "Idempotency-Key is required")
|
assert.Equal(t, http.StatusBadRequest, status, "Idempotency-Key is required")
|
||||||
status, body = call(http.MethodPost, redeem, `{}`, "Idempotency-Key", "r1")
|
status, body = call(http.MethodPost, redeem, `{}`, "Idempotency-Key", "r1")
|
||||||
@@ -377,10 +377,10 @@ func TestEnakGameVoucherEndpoints_AgainstPostgres(t *testing.T) {
|
|||||||
assert.EqualValues(t, 5_000, data(body)["point_balance"])
|
assert.EqualValues(t, 5_000, data(body)["point_balance"])
|
||||||
status, _ = call(http.MethodPost, redeem, `{"pin": "482913"}`, "Idempotency-Key", "r5")
|
status, _ = call(http.MethodPost, redeem, `{"pin": "482913"}`, "Idempotency-Key", "r5")
|
||||||
assert.Equal(t, http.StatusBadRequest, status, "out of codes and of EnakPoint")
|
assert.Equal(t, http.StatusBadRequest, status, "out of codes and of EnakPoint")
|
||||||
status, _ = call(http.MethodPost, "/customer/enakgame/vouchers/"+uuid.NewString()+"/redeem", `{"pin": "482913"}`, "Idempotency-Key", "r4")
|
status, _ = call(http.MethodPost, "/customer/vouchers/"+uuid.NewString()+"/redeem", `{"pin": "482913"}`, "Idempotency-Key", "r4")
|
||||||
assert.Equal(t, http.StatusNotFound, status)
|
assert.Equal(t, http.StatusNotFound, status)
|
||||||
|
|
||||||
status, body = call(http.MethodGet, "/customer/enakgame/redemptions", "")
|
status, body = call(http.MethodGet, "/customer/vouchers/redemptions", "")
|
||||||
require.Equal(t, http.StatusOK, status, body)
|
require.Equal(t, http.StatusOK, status, body)
|
||||||
assert.EqualValues(t, 3, data(body)["pagination"].(map[string]any)["total_count"])
|
assert.EqualValues(t, 3, data(body)["pagination"].(map[string]any)["total_count"])
|
||||||
}
|
}
|
||||||
@@ -477,7 +477,7 @@ func TestEnakGameEventEndpoints_AgainstPostgres(t *testing.T) {
|
|||||||
assert.NotContains(t, events[0], "budget_id", "the budget stays internal")
|
assert.NotContains(t, events[0], "budget_id", "the budget stays internal")
|
||||||
}
|
}
|
||||||
|
|
||||||
// EG-1001: the admin steps of docs/enakgame-spin.md make a spin wheel, and a customer
|
// EG-1001: the admin steps of docs/integration-backoffice.md §8.4 make a spin wheel, and a customer
|
||||||
// plays it through /customer/enakgame/sessions, over HTTP down to Postgres.
|
// plays it through /customer/enakgame/sessions, over HTTP down to Postgres.
|
||||||
func TestEnakGameSpin_AgainstPostgres(t *testing.T) {
|
func TestEnakGameSpin_AgainstPostgres(t *testing.T) {
|
||||||
dsn := os.Getenv("TEST_DATABASE_URL")
|
dsn := os.Getenv("TEST_DATABASE_URL")
|
||||||
|
|||||||
+18
-10
@@ -197,10 +197,13 @@ func (r *Router) addAppRoutes(rg *gin.Engine) {
|
|||||||
enakGame.GET("/sessions", r.enakGameCustomerHandler.ListSessions)
|
enakGame.GET("/sessions", r.enakGameCustomerHandler.ListSessions)
|
||||||
enakGame.GET("/sessions/:id", r.enakGameCustomerHandler.GetSession)
|
enakGame.GET("/sessions/:id", r.enakGameCustomerHandler.GetSession)
|
||||||
enakGame.POST("/sessions/:id/complete", r.enakGameCustomerHandler.CompleteSession)
|
enakGame.POST("/sessions/:id/complete", r.enakGameCustomerHandler.CompleteSession)
|
||||||
enakGame.GET("/vouchers", r.enakGameCustomerHandler.ListVouchers)
|
|
||||||
enakGame.POST("/vouchers/:id/redeem", r.enakGameCustomerHandler.RedeemVoucher)
|
|
||||||
enakGame.GET("/redemptions", r.enakGameCustomerHandler.ListRedemptions)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Vouchers: what EnakPoint is spent on, whatever it came from (docs/rfc-enakgame.md
|
||||||
|
// §5.7, §7.4), so not under /enakgame.
|
||||||
|
customer.GET("/vouchers", r.enakGameCustomerHandler.ListVouchers)
|
||||||
|
customer.GET("/vouchers/redemptions", r.enakGameCustomerHandler.ListRedemptions)
|
||||||
|
customer.POST("/vouchers/:id/redeem", r.enakGameCustomerHandler.RedeemVoucher)
|
||||||
}
|
}
|
||||||
|
|
||||||
selfOrder := v1.Group("/self-order")
|
selfOrder := v1.Group("/self-order")
|
||||||
@@ -634,14 +637,19 @@ func (r *Router) addAppRoutes(rg *gin.Engine) {
|
|||||||
enakGame.POST("/events", r.authMiddleware.RequireLoyaltyManager(), r.enakGameAdminHandler.CreateEvent)
|
enakGame.POST("/events", r.authMiddleware.RequireLoyaltyManager(), r.enakGameAdminHandler.CreateEvent)
|
||||||
enakGame.PUT("/events/:id", r.authMiddleware.RequireLoyaltyManager(), r.enakGameAdminHandler.UpdateEvent)
|
enakGame.PUT("/events/:id", r.authMiddleware.RequireLoyaltyManager(), r.enakGameAdminHandler.UpdateEvent)
|
||||||
enakGame.PUT("/events/:id/status", r.authMiddleware.RequireLoyaltyManager(), r.enakGameAdminHandler.SetEventStatus)
|
enakGame.PUT("/events/:id/status", r.authMiddleware.RequireLoyaltyManager(), r.enakGameAdminHandler.SetEventStatus)
|
||||||
|
}
|
||||||
|
|
||||||
enakGame.GET("/vouchers", r.enakGameAdminHandler.ListVouchers)
|
// Vouchers EnakPoint is redeemed for, whatever it came from; not part of
|
||||||
enakGame.GET("/vouchers/:id", r.enakGameAdminHandler.GetVoucher)
|
// EnakGame. Writing them takes a loyalty manager.
|
||||||
enakGame.GET("/vouchers/:id/codes", r.enakGameAdminHandler.ListVoucherCodes)
|
vouchers := gamification.Group("/vouchers")
|
||||||
enakGame.POST("/vouchers", r.authMiddleware.RequireLoyaltyManager(), r.enakGameAdminHandler.CreateVoucher)
|
{
|
||||||
enakGame.PUT("/vouchers/:id", r.authMiddleware.RequireLoyaltyManager(), r.enakGameAdminHandler.UpdateVoucher)
|
vouchers.GET("", r.enakGameAdminHandler.ListVouchers)
|
||||||
enakGame.PUT("/vouchers/:id/status", r.authMiddleware.RequireLoyaltyManager(), r.enakGameAdminHandler.SetVoucherStatus)
|
vouchers.GET("/:id", r.enakGameAdminHandler.GetVoucher)
|
||||||
enakGame.POST("/vouchers/:id/codes", r.authMiddleware.RequireLoyaltyManager(), r.enakGameAdminHandler.ImportVoucherCodes)
|
vouchers.GET("/:id/codes", r.enakGameAdminHandler.ListVoucherCodes)
|
||||||
|
vouchers.POST("", r.authMiddleware.RequireLoyaltyManager(), r.enakGameAdminHandler.CreateVoucher)
|
||||||
|
vouchers.PUT("/:id", r.authMiddleware.RequireLoyaltyManager(), r.enakGameAdminHandler.UpdateVoucher)
|
||||||
|
vouchers.PUT("/:id/status", r.authMiddleware.RequireLoyaltyManager(), r.enakGameAdminHandler.SetVoucherStatus)
|
||||||
|
vouchers.POST("/:id/codes", r.authMiddleware.RequireLoyaltyManager(), r.enakGameAdminHandler.ImportVoucherCodes)
|
||||||
}
|
}
|
||||||
|
|
||||||
campaignRules := gamification.Group("/campaign-rules")
|
campaignRules := gamification.Group("/campaign-rules")
|
||||||
|
|||||||
Reference in New Issue
Block a user