Pengantar
Panduan integrasi AntaraPay API v1 untuk merchant dan perusahaan: alur singkat, ringkasan endpoint, dan isi panduan.
Kontrak rancangan v1
Dokumen ini adalah kontrak integrasi rancangan v1. URL environment, kredensial, kanal aktif, batas nominal, dan kebijakan fee efektif diberikan saat onboarding. Contoh tidak menandakan bahwa endpoint sudah tersedia di production. Gunakan simulator atau sandbox yang diberikan AntaraPay sebelum aktivasi live.
Tentang panduan ini
Panduan ini menjelaskan cara backend merchant membuat instruksi pembayaran, mengambil QRIS atau VA, mengajukan payout, membaca saldo dan jurnal, serta menerima notifikasi status dari AntaraPay. Pelanggan Anda tetap berinteraksi dengan website atau aplikasi Anda.
Kontrak API v1 · Bahasa Indonesia · 15 Oktober 2026. Host production yang direncanakan: https://api.antarapay.com.
Alur integrasi singkat
- Simpan API key di backend Anda. Buat endpoint webhook HTTPS dan daftarkan melalui dashboard integrasi.
- Buat payin dengan
referencepesanan yang unik danIdempotency-Key. Simpan ID AntaraPay yang diterima. - Ambil status sampai instruksi siap, lalu tampilkan QR atau instruksi pembayaran kepada pelanggan.
- Terima webhook terverifikasi dengan status
completed,failed, atauexpired. Selesaikan pesanan hanya saat webhookcompletedatau GET payinSUCCEEDED; ketersediaan saldo dilihat terpisah. - Untuk mengirim dana, ajukan payout melalui API. AntaraPay menahan saldo dan memprosesnya setelah persetujuan admin.
Ringkasan endpoint
Base path seluruh endpoint adalah /api/v1. Semua POST wajib memakai Idempotency-Key.
| Method | Path | Scope | Fungsi |
|---|---|---|---|
| POST | /api/v1/payins | payins:write | Membuat payin (202) |
| GET | /api/v1/payins | payins:read | Daftar payin |
| GET | /api/v1/payins/{id} | payins:read | Detail payin dan instruksi |
| GET | /api/v1/payins/{id}/qr | payins:read | Gambar QR (PNG) |
| POST | /api/v1/payouts | payouts:write | Mengajukan payout (202) |
| GET | /api/v1/payouts | payouts:read | Daftar payout |
| GET | /api/v1/payouts/{id} | payouts:read | Detail payout |
| POST | /api/v1/payouts/{id}/cancel | payouts:write | Membatalkan payout |
| GET | /api/v1/balances | balances:read | Saldo Active, On Hold, Pending |
| GET | /api/v1/journals | journals:read | Jurnal debit/credit |
| GET | /api/v1/settlements | settlements:read | Settlement |
| GET | /api/v1/channels | channels:read | Kanal, limit, dan kode bank |
| POST | /api/v1/reports/exports | reports:write | Mengajukan ekspor laporan |
| GET | /api/v1/reports/exports/{id} | reports:read | Status ekspor dan URL unduh |
Isi panduan
Bagian 1Environment dan autentikasiBase URL, header wajib, scope API key, penyimpanan dan rotasi key.Bagian 2Format data, idempotency, dan errorTipe data, pagination, retry aman dengan Idempotency-Key, dan kode error.Bagian 3–5PayinMembuat payin, membaca instruksi QRIS/VA, mengambil gambar QR, daftar, dan status.Bagian 6–7PayoutMengajukan payout, membaca status, daftar, dan membatalkan payout.Bagian 8Saldo dan jurnalTiga jenis saldo (Active, On Hold, Pending) dan jurnal debit/credit.Bagian 9Settlement, kanal, dan laporanSettlement, daftar kanal dan bank, serta ekspor laporan CSV/XLSX.Bagian 10Menerima webhookFormat event, jenis event, dan cara endpoint merchant membalas.Bagian 11Signature dan retry webhookVerifikasi HMAC SHA256, langkah pemeriksaan, contoh kode, dan kebijakan retry.Bagian 12Checklist pengujianSkenario pengujian, persiapan production, dan informasi untuk investigasi.