Get the settlements

GET/v1/reports/settlementsRun

Requires balances:read permission.

Query parameters

fromstringrequired

The first day of the period, YYYY-MM-DD in Jakarta time. It is included.

Example: 2026-10-01

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

tostringrequired

The last day of the period, YYYY-MM-DD in Jakarta time. It is included.

Example: 2026-10-26

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

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

fromstringrequired

The first day of the period, YYYY-MM-DD in Jakarta time. It is included.

Example: 2026-10-01

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

tostringrequired

The last day of the period, YYYY-MM-DD in Jakarta time. It is included.

Example: 2026-10-26

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

daysarray of objectrequired

One row for each business day that had paid payments.

business_daystringrequired

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

Example: string

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

paid_countintegerrequired

How many payments were paid that day.

Example: 5

charged_amountintegerrequired

Total charged to the payer, including the fee when the payer bears it, in the smallest unit of currency (Rp125.000 is 12500000).

Example: 1000000

fee_amountintegerrequired

Baiyar's fee for this payment, in the smallest unit of currency (Rp125.000 is 12500000).

Example: 7000

net_amountintegerrequired

The amount credited after the Baiyar fee, in the smallest unit of currency (Rp125.000 is 12500000).

Example: 993000

settled_countintegerrequired

How many of them the provider has settled.

Example: 5

settled_net_amountintegerrequired

Net amount of that day's payments already matched to a provider settlement, in the smallest unit of currency (Rp125.000 is 12500000).

Example: 4965000

statusstringrequired

awaiting (none settled), partial or settled (all settled).

Example: settled

Possible values: awaiting, partial, settled

last_settled_atstring | nullrequired

Time the latest payment in this row was matched to a provider settlement; null if none has settled yet.

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

Format: date-time

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

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

Response

{
  "data": {
    "livemode": false,
    "currency": "IDR",
    "from": "2026-10-01",
    "to": "2026-10-26",
    "days": [
      {
        "business_day": "string",
        "paid_count": 5,
        "charged_amount": 1000000,
        "fee_amount": 7000,
        "net_amount": 993000,
        "settled_count": 5,
        "settled_net_amount": 4965000,
        "status": "settled",
        "last_settled_at": "2026-10-26T03:04:05.000Z"
      }
    ]
  },
  "meta": {
    "request_id": "req_Hy3k9QzT2LmN8vXa"
  }
}