KiPaydocs
Dokumentasi/API Reference

API REFERENCE

Empat operasi untuk satu lifecycle pembayaran

Referensi ini menjelaskan kontrak publik KiPay saat ini, termasuk parameter, response, error, dan batas perilakunya.

API CONSOLE

Kirim request langsung dan baca response dengan jelas

Masukkan API key sandbox, periksa parameter, lalu jalankan endpoint dari halaman ini. Credential hanya diteruskan untuk request tersebut dan tidak disimpan.

POSThttps://api.kipay.biz.id/api/pay/{apiKey}/transactions
Buat transaksi
Contoh response
RequestSandbox
Authentication

API key diteruskan satu kali melalui server KiPay dan tidak disimpan oleh konsol.

Headers
Acceptapplication/jsonContent-Typeapplication/json
Request body
Responseapplication/json
CONTOHPreview bodyBelum dikirim
1{2  "trx_id": "SBX-20260825-VG57V5",3  "mode": "sandbox",4  "requested_amount": 285000,5  "unique_code": 215,6  "amount": 285215,7  "status": "pending",8  "expires_at": "2026-08-26 06:50:08"9}
Contoh kode
curl --request POST \
  --url https://api.kipay.biz.id/api/pay/$KIPAY_API_KEY/transactions \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"amount":285000,"note":"order_nusa_2048"}'
OPERASI RESOURCEEmpat endpoint ditempatkan pada momen lifecycle yang tepat.
Endpoint API dalam lifecycle transaksiPOST create memulai resource transaksi. GET retrieve membaca status sepanjang lifecycle. GET qr.png digunakan saat pending. POST simulate hanya digunakan di sandbox untuk mengubah pending menjadi paid atau expired.semua operasi terhubung lewat trx_idDIBUATPENDINGAKHIRpaid atau expiredPOSTbuat transaksimemulai satu resourceGETrender QRselama status pendingPOSTsimulasikhusus sandboxGETbaca transaksikontrak baca sama di setiap status
01

Base URL

Semua endpoint publik menggunakan HTTPS. apiKey pada path mengikat setiap request ke project pemiliknya. Selalu kirim request dari backend.

base-url
Text
https://api.kipay.biz.id
02

Operasi

MethodPathTujuan
POST/api/pay/{apiKey}/transactionsBuat transaksi
GET/api/pay/{apiKey}/transactions/{trxId}Baca status
GET/api/pay/{apiKey}/transactions/{trxId}/qr.pngAmbil gambar QR
POST/api/pay/{apiKey}/transactions/{trxId}/simulateSimulasikan paid pada sandbox
03

Format data

  • Request dan response utama menggunakan application/json
  • Endpoint QR mengembalikan image/png
  • Timestamp ditampilkan sebagai string date-time
  • Nominal disimpan sebagai integer dalam rupiah
  • trx_id sandbox diawali SBX
04

Dokumen OpenAPI

Gunakan dokumen OpenAPI sebagai sumber kontrak yang dapat diproses oleh tool. Gunakan panduan ini untuk memahami workflow dan keputusan integrasi.

openapi-url
Text
https://api.kipay.biz.id/openapi.json