Lihat statement

GET/v1/reports/statementJalankan

Membutuhkan izin balances:read.

Parameter query

accountstringopsional

Saldo yang dibahas laporan: pending atau available (statement), atau saldo tempat sebuah pencatatan berada (buku besar).

Contoh: available

Nilai yang mungkin: pending, available

fromstringwajib

Hari pertama periode, YYYY-MM-DD waktu Jakarta. Hari itu ikut dihitung.

Contoh: 2026-10-01

Pola: ^\d{4}-\d{2}-\d{2}$

tostringwajib

Hari terakhir periode, YYYY-MM-DD waktu Jakarta. Hari itu ikut dihitung.

Contoh: 2026-10-26

Pola: ^\d{4}-\d{2}-\d{2}$

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

accountstringwajib

Saldo yang dibahas laporan: pending atau available (statement), atau saldo tempat sebuah pencatatan berada (buku besar).

Contoh: available

Nilai yang mungkin: pending, available

fromstringwajib

Hari pertama periode, YYYY-MM-DD waktu Jakarta. Hari itu ikut dihitung.

Contoh: 2026-10-01

Pola: ^\d{4}-\d{2}-\d{2}$

tostringwajib

Hari terakhir periode, YYYY-MM-DD waktu Jakarta. Hari itu ikut dihitung.

Contoh: 2026-10-26

Pola: ^\d{4}-\d{2}-\d{2}$

opening_balanceintegerwajib

Saldo di awal periode, dalam satuan terkecil currency (Rp125.000 adalah 12500000).

Contoh: 0

total_inintegerwajib

Semua yang masuk selama periode, dalam satuan terkecil currency (Rp125.000 adalah 12500000).

Contoh: 3200000

total_outintegerwajib

Semua yang keluar selama periode, dalam satuan terkecil currency (Rp125.000 adalah 12500000).

Contoh: 0

closing_balanceintegerwajib

Saldo di akhir periode: awal, ditambah masuk, dikurangi keluar, dalam satuan terkecil currency (Rp125.000 adalah 12500000).

Contoh: 3200000

linesarray dari objectwajib

Mutasi atau pencatatan selama periode, terlama dahulu.

idstringwajib

Id entri.

Contoh: string

typestringwajib

Peristiwa yang membuat pencatatan saldo ini, seperti payment_paid atau payment_settled.

Contoh: payment_settled

Nilai yang mungkin: payment_paid, payment_settled, payment_settled_reversed, payment_paid_reversed, payment_reversed, payment_reversal_cancelled

payment_idstring | nullwajib

Pembayaran terkait; null jika event tidak membahas pembayaran.

Contoh: pay_01k7q3m8x2v5t9n4b6c1d0e7fa

Diawali pay_.

directionstringwajib

in menambah saldo, out mengurangi.

Contoh: in

Nilai yang mungkin: in, out

amountintegerwajib

Nominal entri, dalam satuan terkecil currency (Rp125.000 adalah 12500000).

Contoh: 993000

balance_afterintegerwajib

Saldo tepat setelah entri, dalam satuan terkecil currency (Rp125.000 adalah 12500000).

Contoh: 3200000

occurred_atstringwajib

Kapan dicatat (RFC 3339, UTC).

Contoh: 2026-10-26T03:04:05.000Z

Format: date-time

business_daystringwajib

Tanggal Jakarta untuk mengelompokkan pembayaran atau pencatatan saldo ini, YYYY-MM-DD.

Contoh: string

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

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

Respons

{
  "data": {
    "livemode": false,
    "currency": "IDR",
    "account": "available",
    "from": "2026-10-01",
    "to": "2026-10-26",
    "opening_balance": 0,
    "total_in": 3200000,
    "total_out": 0,
    "closing_balance": 3200000,
    "lines": [
      {
        "id": "string",
        "type": "payment_settled",
        "payment_id": "pay_01k7q3m8x2v5t9n4b6c1d0e7fa",
        "direction": "in",
        "amount": 993000,
        "balance_after": 3200000,
        "occurred_at": "2026-10-26T03:04:05.000Z",
        "business_day": "string"
      }
    ]
  },
  "meta": {
    "request_id": "req_Hy3k9QzT2LmN8vXa"
  }
}