Daftar mutasi saldo

GET/v1/balance/movementsJalankan

Membutuhkan izin balances:read.

Parameter query

accountstringopsional

Pilih mutasi saldo yang dikembalikan: pending atau available.

Contoh: available

Nilai yang mungkin: pending, available

beforestringopsional

Id mutasi tertua di halaman yang sudah kamu punya. Halaman berikutnya berlanjut sebelum mutasi itu.

Contoh: string

Pola: ^[0-9]{1,18}$

limitintegeropsional

Jumlah item per halaman, dari 1 sampai 100. Bawaannya 20.

Contoh: 20

Minimum: 1

Maksimum: 100

Respons (200)

Mengembalikan satu halaman daftar: data berisi item, dan meta.pagination menunjukkan kelanjutannya. Halaman berikutnya dengan limit dan starting_after (id item terakhir yang sudah kamu punya), atau ambil meta.pagination.next.

dataarray dari objectwajib

Objek yang dikembalikan, atau array objek untuk operasi daftar.

idstringwajib

Id mutasi.

Contoh: string

typestringwajib

Apa yang menggerakkan saldo, misalnya payment_paid, payment_settled, atau payment_settled_reversed.

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

Berapa yang bergerak, dalam satuan terkecil currency (Rp125.000 adalah 12500000).

Contoh: 993000

balance_afterintegerwajib

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

Contoh: 3200000

occurred_atstringwajib

Kapan bergerak (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

accountstringwajib

Menunjukkan saldo tempat mutasi yang dikembalikan: pending atau available.

Contoh: available

Nilai yang mungkin: pending, available

paginationobjectwajib

Detail paginasi untuk respons daftar. Gunakan next untuk mengambil halaman berikutnya, atau starting_after untuk menyusun URL sendiri.

per_pageintegerwajib

Jumlah item yang dikembalikan di halaman ini.

Contoh: 20

has_morebooleanwajib

true berarti masih ada item di halaman berikutnya.

nextstring | nullwajib

Alamat halaman berikutnya, dengan filtermu tetap; null di halaman terakhir.

Contoh: string

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

Request

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

Respons

{
  "data": [
    {
      "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",
    "account": "available",
    "pagination": {
      "per_page": 20,
      "has_more": true,
      "next": "https://api.baiyar.com/v1/balance/movements?before=184"
    }
  }
}