List balance movements

GET/v1/balance/movementsRun

Requires balances:read permission.

Query parameters

accountstringoptional

Choose which balance's movements to return: pending or available.

Example: available

Possible values: pending, available

beforestringoptional

The id of the oldest movement on the page you have. The next page continues before it.

Example: string

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

limitintegeroptional

How many items one page holds, from 1 to 100. The default is 20.

Example: 20

Minimum: 1

Maximum: 100

Response (200)

Returns a page of a list: data holds the items, and meta.pagination says how the list goes on. Page with limit and starting_after (the id of the last item you have), or fetch meta.pagination.next.

dataarray of objectrequired

The returned object, or an array of objects for a list.

idstringrequired

The id of the movement.

Example: string

typestringrequired

What moved the balance, for example payment_paid, payment_settled or payment_settled_reversed.

Example: payment_settled

Possible values: payment_paid, payment_settled, payment_settled_reversed, payment_paid_reversed, payment_reversed, payment_reversal_cancelled

payment_idstring | nullrequired

Related payment; null when the event is not about a payment.

Example: pay_01k7q3m8x2v5t9n4b6c1d0e7fa

Prefixed with pay_.

directionstringrequired

in adds to the balance, out takes from it.

Example: in

Possible values: in, out

amountintegerrequired

How much moved, in the smallest unit of currency (Rp125.000 is 12500000).

Example: 993000

balance_afterintegerrequired

The balance right after this movement, in the smallest unit of currency (Rp125.000 is 12500000).

Example: 3200000

occurred_atstringrequired

When it moved (RFC 3339, UTC).

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

Format: date-time

business_daystringrequired

The Jakarta calendar day used to group this payment or balance entry, YYYY-MM-DD.

Example: string

metaobjectrequired

Request details such as its id and pagination cursor.

request_idstringrequired

The id of this request. Quote it when you ask support about it.

Example: req_Hy3k9QzT2LmN8vXa

accountstringrequired

Identifies which balance the returned movements belong to: pending or available.

Example: available

Possible values: pending, available

paginationobjectrequired

Pagination details for a list response. Use next to fetch the next page, or starting_after to build the URL yourself.

per_pageintegerrequired

Number of items returned on this page.

Example: 20

has_morebooleanrequired

true means more items are available on another page.

nextstring | nullrequired

The address of the next page, with your filters kept; null on the last page.

Example: string

A failed request answers with the common error shape; see Errors.

Request

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

Response

{
  "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"
    }
  }
}