Relay Merchant API
Selamat datang di dokumentasi Relay Merchant API — platform PPOB (Payment Point Online Bank) untuk merchant yang ingin mengintegrasikan layanan pembayaran, transfer dana, dan penerimaan pembayaran QRIS ke dalam sistem mereka.
Cakupan Dokumentasi
Dokumentasi ini mencakup seluruh endpoint API yang tersedia untuk merchant:
| Kategori | Deskripsi | Base Path |
|---|---|---|
| PPOB | Pulsa, e-wallet, token PLN, tagihan PLN, BPJS | /api/v1/merchant/ppob |
| Disbursement | Transfer dana ke rekening bank | /api/v1/merchant/disbursement |
| PayIn QRIS | Terima pembayaran via QRIS | /api/v1/merchant/payin |
| Utilitas | Cek saldo, katalog produk | /api/v1/balance, /api/v1/product |
Base URL
| Lingkungan | URL |
|---|---|
| Sandbox | https://api-sandbox.alfakios.com |
| Production | https://api.alfakios.com |
Gunakan lingkungan Sandbox untuk pengembangan dan pengujian. Transaksi sandbox tidak memotong saldo nyata.
Prasyarat Integrasi
Sebelum mulai mengintegrasikan API, pastikan Anda memiliki:
- Akun merchant yang telah aktif di CMS (backoffice).
- API Key yang di-generate dari menu API Keys di CMS.
- Signature Secret (opsional, jika fitur Signature Validation diaktifkan) — diberikan oleh tim support.
- Saldo deposit yang cukup untuk melakukan transaksi.
Cara Membaca Dokumentasi Ini
- Memulai Integrasi — baca bagian ini terlebih dahulu untuk memahami mekanisme autentikasi dan format request/response.
- Kategori API — setiap kategori memiliki halaman gambaran umum yang menjelaskan alur transaksi, diikuti halaman detail per endpoint.
- Lampiran — contoh integrasi end-to-end dalam berbagai bahasa pemrograman.
Konvensi Dokumen
- Field bertanda *Ya* pada tabel request wajib disertakan.
- Semua contoh menggunakan
apk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxsebagai placeholder API Key — ganti dengan API Key Anda yang sebenarnya. - Nominal (
amount) selalu berupa string digit dalam satuan IDR (contoh:"100000"= Rp 100.000).
Bantuan Teknis
Untuk pertanyaan teknis terkait integrasi, hubungi tim Backend API melalui grup WhatsApp yang dibuat oleh marketing.