Dokumentasi API QRISPay

Integrasi untuk bot / website. Autentikasi via header x-api-key.

Base URL

Buat QRIS

POST /api/v1/qris — x-api-key

POST /api/v1/qris
x-api-key: ***
Content-Type: application/json

{ "amount": 10000, "provider": "qris", "reference": "INV-1", "callback_url": "https://yourbot/webhook" }

→ 201
{ "success": true, "data": { "qris_id": "...", "qris_code": "000201...", "qr_url": "/qr/...", "amount": 10121, "expires_at": "..." } }

amount = nominal dasar (base). Gateway menambahkan fee platform 1% (min Rp 100) + kode unik (11–99) untuk matching, sehingga nominal QRIS = base + fee + unik. provider opsional — nilai yang diterima: "qris" (H+1, default) atau "realtime" (H+0, butuh paket prioritas). Jika di-omit, dipilih otomatis sesuai tier langganan. Hanya provider yang diizinkan tier Anda yang bisa dipakai.

Siapa yang menanggung fee bisa diatur per-merchant dari dashboard: mode Pembeli menambahkan fee ke nominal QRIS (pembeli bayar base+fee+unik), mode Merchant memunculkan nominal base+unik saja dan memotong fee dari payout. Kode unik selalu ada di kedua mode.

Cek Status (polling)

GET /api/v1/qris/:id/status — publik

GET /api/v1/qris/{qris_id}/status

→ 200 { "success": true, "paid": false, "status": "PENDING" }
→ 200 { "success": true, "paid": true, "status": "PAID", "transaction": {...} }
→ 410 { "success": false, "status": "EXPIRED" }

Polling tiap 3–5 detik. Saat PENDING, gateway otomatis fetch mutasi provider dan coba settle. Tidak perlu webhook, tapi disarankan pakai webhook untuk reliabilitas.

Akun & Saldo

GET  /api/v1/me              x-api-key  → subscription + allowed_providers + balance
GET  /api/v1/balance         x-api-key  → { balance, held, available }
POST /api/v1/withdraw        x-api-key  → { amount, bank_detail: { bank_name, account_number, account_name } }
GET  /api/v1/withdrawals     x-api-key
GET  /api/v1/transactions    x-api-key
GET  /api/v1/ledger          x-api-key  → audit trail

Webhooks

GET    /api/v1/webhooks      x-api-key
POST   /api/v1/webhooks      x-api-key  → { url, secret?, events?: ["payment.success"] }
DELETE /api/v1/webhooks/:id  x-api-key

Event payment.success dikirim ke URL Anda dengan signature X-Webhook-Signature: sha256=... (HMAC-SHA256 dari body). Verifikasi:

const crypto = require('crypto');
const sig = 'sha256=' + crypto.createHmac('sha256', secret).update(rawBody).digest('hex');
crypto.timingSafeEqual(Buffer.from(sig), Buffer.from(req.headers['x-webhook-signature']));

Health

GET /api/v1/healthz → { "status": "healthy" }

Metode Pembayaran

Pilih metode dari dashboard (menu Overview) atau lewat API. Metode selain yang diizinkan tier Anda → 403 PROVIDER_NOT_PERMITTED.