Konvensi
Yang sama untuk setiap request Merchant API Baiyar: host, body, dan di mana detail tiap konvensi.
| Sandbox | Live | |
|---|---|---|
| Host | https://api.baiyar.com |
https://api.baiyar.com |
| Key | bk_test_… |
bk_live_… |
Sandbox dan live memakai satu host: key yang kamu kirim menentukan environment yang dituju, dan datanya terpisah. Lihat Autentikasi.
Request dan jawaban berupa JSON. Field yang tidak dikenal API ditolak, bukan diabaikan, jadi salah ketik field menjadi error. Kirim Content-Type: application/json kalau ada body.
Setiap respons
Section titled “Setiap respons”Jawaban sukses berbentuk { "data": …, "meta": { "request_id": … } } dan yang gagal { "error": …, "meta": { "request_id": … } }: lihat Respons sukses. Setiap respons juga membawa header x-request-id, sama dengan meta.request_id. Sebutkan saat bertanya kepada kami tentang sebuah request.
Konvensi lainnya
Section titled “Konvensi lainnya”| Topik | Isinya |
|---|---|
| Autentikasi | Key, environment, pembatasan |
| Izin | Apa yang boleh dilakukan key, dan izin yang dibutuhkan tiap operasi |
| Rate limit | Request per menit dan cara menangani 429 |
| Idempotensi | Mengulang tanpa pembayaran kedua |
| Tipe data | Nominal, waktu, boolean, dan null |
| Identifier | Arti pay_… dan awalan lainnya |
| Paginasi dan Filter daftar | Membaca daftar |
| Metadata | Teksmu sendiri pada pembayaran |
| Respons sukses dan Error | Yang kembali |
| Hapus dan batalkan dan Putar API key | Mengakhiri dan mengganti |