Get balance

Returns the pending, available and reserved balances.

GET/v1/balance

Requires balances:read permission.

Response (200)

dataobjectrequired

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

livemodebooleanrequired

true means this object belongs to live and can involve real payments; false means it belongs to the sandbox.

currencystringrequired

The currency, an ISO 4217 code. Only IDR today.

Example: IDR

Value: IDR

pendingintegerrequired

Paid funds that have not yet been matched to the provider's settlement. They are not in the available balance yet, in the smallest unit of currency (Rp125.000 is 12500000).

Example: 1500000

availableintegerrequired

Funds matched to the provider's settlement and moved out of pending, in the smallest unit of currency (Rp125.000 is 12500000).

Example: 3200000

reservedintegerrequired

Funds set aside and unavailable for other use, for example while a withdrawal is being processed, in the smallest unit of currency (Rp125.000 is 12500000).

Example: 0

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

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

Request
Response

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