Dokumentasi API

Panduan lengkap integrasi API pembayaran untuk aplikasi atau platform Anda.

A. Persiapan & Otentikasi

Otentikasi ke API dilakukan menggunakan kunci rahasia (**API Key**). Anda dapat menggunakan kunci tersebut dalam 2 cara:

  • Mengirimkannya melalui HTTP Header (Sangat Direkomendasikan): x-api-key: YOUR_API_KEY
  • Mengirimkannya melalui parameter URL (Query): ?apikey=YOUR_API_KEY

B. Cek Saldo (Balance)

GET

Gunakan endpoint ini untuk mendapatkan informasi saldo akun Anda secara real-time.

Endpoint: /api/v1/balance

Parameter:

  • apikey (string, opsional jika memakai Header) – Kunci API Anda.

Contoh Request:

/api/v1/balance?apikey=YOUR_API_KEY

Contoh Response (JSON):

{
  "balance": 150000
}

C. Membuat Invoice Baru

GET

Endpoint ini digunakan untuk meng-generate QRIS untuk transaksi/deposit baru. Kirimkan nominal dan API Key Anda di dalam URL.

Endpoint: /api/v1/invoice

Parameter:

  • apikey (string, wajib) – Kunci API Anda.
  • amount (integer, wajib) – Nominal deposit (min. Rp 1.000).

Contoh Request:

/api/v1/invoice?apikey=YOUR_API_KEY&amount=50000

Contoh Response (JSON):

{
  "success": true,
  "invoice_id": "INV-X89J21",
  "amount": 50000,
  "fee": 15,
  "total": 50015,
  "qris_image": "https://...",
  "expired_at": "2026-06-20T14:30:00.000Z"
}

D. Cek Status Invoice

GET

Setelah pengguna melakukan scan QRIS, gunakan endpoint ini untuk mengecek apakah pembayaran telah berhasil atau belum.

Endpoint: /api/v1/invoice/status

Parameter:

  • apikey (string, wajib) – Kunci API Anda.
  • invoice_id (string, wajib) – ID Invoice yang ingin dicek.

Contoh Request:

/api/v1/invoice/status?apikey=YOUR_API_KEY&invoice_id=INV-X89J21

Contoh Response (JSON):

{
  "invoice_id": "INV-X89J21",
  "amount": 50000,
  "fee": 15,
  "total": 50015,
  "status": "paid",
  "qris_image": "https://...",
  "expired_at": "2026-06-20T14:30:00.000Z",
  "created_at": "2026-06-20T14:00:00.000Z"
}