Dokumentasi API
Hubungkan server toko ke tagihan dan webhook SYNX Pay. Contoh di bawah memakai Sandbox.
Dokumentasi untuk AI
Berikan panduan ini ke AI dan isi SYNX_SANDBOX_API_KEY di environment proyek yang akan diuji.
https://synxpay.idKredensial server
Member membuat key sendiri di Integrasi & API. Pakai /api/member/invoices untuk Sandbox per akun. Contoh operator di bawah memakai key Sandbox dari Integrasi admin dan path /api/invoices.
Member dengan akses Live dapat memakai key Live pada /api/member/live/invoices dan /api/member/live/payments. Kedua endpoint dibatasi ke toko pemilik key.
Buat tagihan
amount berupa bilangan bulat rupiah. Tambahkan reference dari sistem pesanan. Gunakan expire_minutes dari 1 sampai 60 bila ingin mengatur masa berlaku.
curl -X POST https://synxpay.id/api/invoices \
-H "X-Api-Key: $SYNX_SANDBOX_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: pesanan-2701" \
-d '{"amount":125000,"reference":"ORDER-2701","description":"Pesanan uji","mode":"sandbox"}'Gabungkan URL situs dengan path pada invoice.pay_url untuk membuka checkout. Jika request perlu diulang, kirim input dan Idempotency-Key yang sama. Isi berbeda dengan key yang sama dijawab 409.
Daftar endpoint
| Endpoint | Kegunaan | Akses |
|---|---|---|
POST /api/invoices | Buat tagihan. Respons 201 untuk tagihan baru dan 200 saat request idempoten diulang. | API key atau sesi admin |
GET /api/invoices | Saring daftar dengan mode, status, from, to, q, limit dan offset. | API key atau sesi admin |
GET /api/invoices/:id | Cek status publik. Tambahkan ?include_qr=0 untuk polling tanpa gambar. | Tautan checkout |
POST /api/invoices/:id/cancel | Batalkan tagihan yang masih menunggu. | API key atau sesi admin |
GET /api/payment-links | Daftar tautan checkout berulang yang dikelola admin. | API key atau sesi admin |
POST /api/payment-links | Buat tautan berulang dengan judul dan nominal yang ditetapkan. | API key atau sesi admin |
GET /api/payments | Ambil pembayaran yang tercatat lunas. | API key atau sesi admin |
GET /api/payments.csv | Ekspor pembayaran dengan filter yang sama. | API key atau sesi admin |
POST /api/invoices/:id/simulate | Simulasi lunas atau kedaluwarsa di Sandbox. | Key Sandbox atau sesi admin |
Status pembayaran
pendingmenunggu pembayaran.paidlunas.expiredmelewati masa bayar.cancelleddibatalkan.
Gunakan invoice.amount sebagai nominal akhir yang ditampilkan. base_amount adalah nominal awal. Sesuaikan mode dari nilai livemode.
Tagihan baru di Live dan Sandbox mendapat unique_code Rp200–Rp350 otomatis. Pembeli membayar harga barang ditambah kode tersebut. Untuk harga Rp10.000 dan kode Rp203, total bayar Rp10.203, service_fee Rp203 dan net_amount Rp10.000. Untuk harga Rp600.000 dan kode Rp201, total bayar Rp600.201, biaya Rp4.401 dan neto Rp595.800. Gunakan nilai dari respons setiap kali menampilkan bukti bayar.
Webhook bertanda tangan
Atur penerima HTTPS publik dari Integrasi atau beri webhook_url pada permintaan tagihan. Event yang dikirim mencakup payment.success, payment.expired, dan payment.cancelled.
HMAC-SHA256(secret, X-Webhook-Timestamp + "." + rawBody)Bandingkan hasil hex dengan X-Webhook-Signature, cek umur timestamp, dan proses satu kali per X-Webhook-Id. Balas HTTP 2xx setelah event tersimpan. Gateway mencoba ulang pengiriman yang gagal.
Uji tanpa transaksi sungguhan
Admin dapat membuat tagihan dan mengirim {"action":"pay"} ke endpoint simulasi, atau memakai tombol di dashboard. Member yang disetujui membuat dan mensimulasikan tagihan sendiri dari panel member.