Lihat saldo

Mengembalikan saldo tertunda, tersedia, dan tertahan.

GET/v1/balance

Membutuhkan izin balances:read.

Respons (200)

dataobjectwajib

Objek yang dikembalikan, atau array objek untuk operasi daftar.

livemodebooleanwajib

true berarti objek ini ada di live dan bisa melibatkan pembayaran sungguhan; false berarti objek ini ada di sandbox.

currencystringwajib

Mata uang, kode ISO 4217. Saat ini hanya IDR.

Contoh: IDR

Nilai: IDR

pendingintegerwajib

Dana pembayaran yang belum dicocokkan dengan settlement penyedia. Dana ini belum masuk ke saldo tersedia, dalam satuan terkecil currency (Rp125.000 adalah 12500000).

Contoh: 1500000

availableintegerwajib

Dana yang sudah cocok dengan settlement penyedia dan dipindahkan dari saldo tertunda, dalam satuan terkecil currency (Rp125.000 adalah 12500000).

Contoh: 3200000

reservedintegerwajib

Dana yang disisihkan dan belum bisa digunakan untuk hal lain, misalnya saat penarikan sedang diproses, dalam satuan terkecil currency (Rp125.000 adalah 12500000).

Contoh: 0

metaobjectwajib

Detail request seperti id dan kursor paginasi.

request_idstringwajib

Id request ini. Sebutkan saat bertanya ke dukungan.

Contoh: req_Hy3k9QzT2LmN8vXa

Request yang gagal dijawab dengan bentuk error yang sama; lihat Error.

Request
Respons

curl "https://api.baiyar.com/v1/balance" \
  -H "Authorization: Bearer $BAIYAR_KEY"

{
  "data": {
    "livemode": false,
    "currency": "IDR",
    "pending": 1500000,
    "available": 3200000,
    "reserved": 0
  },
  "meta": {
    "request_id": "req_Hy3k9QzT2LmN8vXa"
  }
}