API mitra penagihan

Punya aplikasi yang menagih pelanggan secara berkala, misalnya iuran warga, langganan internet, uang sekolah, atau cicilan? Dengan API ini tagihan Anda muncul di aplikasi Kliro, sehingga pelanggan bisa membayarnya sendiri atau lewat konter Kliro Bisnis terdekat.

Alur kerja

1. Aplikasi Anda mengirim tagihan ke Kliro: nomor pelanggan, nama, periode, dan nominal.
2. Pelanggan membayar di Kliro: memilih nama usaha Anda, mengetik nomor pelanggan, melihat tagihannya, lalu membayar dengan saldo, QRIS, atau transfer.
3. Aplikasi Anda mengambil kabar pembayaran secara berkala dan menandai tagihan lunas.

Kliro tidak pernah memanggil aplikasi Anda. Aplikasi Andalah yang mengirim dan mengambil, jadi tidak perlu alamat publik, domain, atau webhook. Aplikasi yang berjalan di HP atau STB di jaringan rumah pun bisa.

Mulai

1. Hubungi Kliro untuk mendaftar sebagai mitra penagihan di kliro@briix.co.id. Sebutkan nama usaha yang ingin ditampilkan ke pembayar.
2. Anda menerima kunci uji (berawalan bp_test_). Tagihan mode uji tidak sungguhan dan terpisah sepenuhnya dari mode nyata.
3. Setelah integrasi berjalan, Anda menerima kunci nyata (berawalan bp_live_).

Alamat dasar: https://pay.briix.co.id. Setiap permintaan menyertakan header:

Authorization: Bearer bp_test_xxxxxxxxxxxxxxxx
Content-Type: application/json

Jaga kunci seperti kata sandi: simpan di server atau perangkat Anda, jangan di kode yang dibagikan ke pelanggan.

Kirim atau perbarui tagihan

{
  "external_id": "INV-2026-11-0012",
  "customer_no": "050012",
  "customer_name": "Pak Budi",
  "period": "NOV 2026",
  "amount": 50000,
  "due_date": "2026-11-10",
  "details": {"Blok": "C-12"}
}

Jawaban 201 untuk tagihan baru dan 200 untuk pembaruan, berisi tagihan lengkap dengan id dan status (open, paid, atau cancelled).

Bila satu pelanggan punya beberapa tagihan terbuka, pembayar ditawari yang jatuh temponya paling awal lebih dulu. Tagihan berikutnya muncul setelah yang itu lunas.

Ambil kabar pembayaran

{
  "data": [
    {
      "seq": 42,
      "type": "bill.paid",
      "created_at": "2026-11-15T03:10:00Z",
      "bill": {
        "id": "019a…",
        "external_id": "INV-2026-11-0012",
        "customer_no": "050012",
        "amount": 50000,
        "status": "paid",
        "paid_at": "2026-11-15T03:10:00Z"
      }
    }
  ],
  "next": 42
}

Simpan nilai next, lalu panggil lagi dengan after=next, misalnya tiap 1 sampai 5 menit. Kabar selalu berurutan dan tidak hilang. Mengambil ulang dari after yang lama mengembalikan kabar yang sama, jadi tandai lunas berdasarkan external_id supaya aman diulang.

Lihat dan batalkan

{id} boleh ID dari Kliro atau external_id Anda. Batalkan tagihan bila pelanggan membayar langsung kepada Anda (tunai) atau tagihannya salah, supaya tidak terbayar dua kali. Tagihan yang sudah lunas tidak bisa diubah atau dibatalkan.

Ringkasan dan penyerahan uang

Anda menerima nominal tagihan utuh. Pembayar menanggung biaya admin di atas nominal itu. Uang yang terkumpul diserahkan ke rekening Anda sesuai jadwal yang disepakati saat pendaftaran.

Galat

Galat dikembalikan sebagai JSON dengan status, title, dan detail berbahasa Indonesia.

Contoh dengan curl

curl -X POST https://pay.briix.co.id/v1/biller/bills \
  -H "Authorization: Bearer $KUNCI" \
  -H "Content-Type: application/json" \
  -d '{"external_id":"INV-2026-11-0012","customer_no":"050012",
       "customer_name":"Pak Budi","period":"NOV 2026","amount":50000}'

curl "https://pay.briix.co.id/v1/biller/events?after=0" \
  -H "Authorization: Bearer $KUNCI"

Spesifikasi lengkap dalam format OpenAPI: https://pay.briix.co.id/v1/openapi.json.

Belum punya aplikasi sendiri? Kliro sedang menyiapkan aplikasi penagihan siap pakai yang bisa dipasang di HP atau STB dan memakai API ini.