Dokumentasi API
Panduan lengkap integrasi API pembayaran untuk aplikasi Anda.
A. Persiapan
Langkah pertama yang harus Anda lakukan adalah mendaftar dan login ke dashboard. Setelah itu, dapatkan API Key Anda di menu Profil untuk mulai mengintegrasikan sistem pembayaran ke aplikasi Anda.
B. Cek Saldo (Balance)
Gunakan endpoint ini untuk mendapatkan informasi saldo akun Anda secara real-time.
- Method: GET
- URL:
/api/v1/balance
Parameter:
- Header
X-API-Key(string, wajib) – Kunci API pengguna
Contoh Request:
curl -H "X-API-Key: YOUR_API_KEY" /api/v1/balance
Contoh Response:
{
"balance": 150000
}
C. Membuat Invoice Baru
Endpoint ini digunakan untuk meng-generate QRIS untuk transaksi/deposit baru. Kirim nominal pada body JSON dan API Key melalui header X-API-Key.
- Method: POST
- URL:
/api/v1/invoice
Parameter:
- Header
X-API-Key(string, wajib) – Kunci API pengguna amount(integer, wajib) – Nominal deposit (min. 1.000)
Contoh Request:
curl -X POST -H "X-API-Key: YOUR_API_KEY" -H "Content-Type: application/json" -d '{"amount":50000}' /api/v1/invoice
Contoh Response:
{
"success": true,
"invoice_id": "64c8d9e...",
"amount": 50000,
"fee": 500,
"total": 50500,
"qris_image": "https://...",
"expired_at": "2025-01-01 12:00:00"
}
D. Cek Status Invoice
Setelah pengguna melakukan scan QRIS, gunakan endpoint ini untuk mengecek apakah pembayaran telah berhasil atau belum.
- Method: GET
- URL:
/api/v1/invoice/status
Parameter:
- Header
X-API-Key(string, wajib) – Kunci API pengguna invoice_id(string, wajib) – ID Invoice yang ingin dicek
Contoh Request:
curl -H "X-API-Key: YOUR_API_KEY" "/api/v1/invoice/status?invoice_id=INSERT_ID_HERE"
Contoh Response:
{
"invoice_id": "64c8d9e...",
"amount": 50000,
"fee": 500,
"total": 50500,
"status": "paid",
"qris_image": "https://...",
"expired_at": "2025-01-01 12:00:00",
"created_at": "2025-01-01 11:30:00"
}