Skip to content
Baiyar DocsBaiyar DocsBaiyar Docs

Get the reconciliation

Lists paid payments and their settlement state: reconciled, awaiting, late, checking or held.

GET/v1/reports/reconciliation
Requires balances:read permission.

Query parameters

Section titled “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}$

statusstringoptional

Filter reconciliation rows by status: reconciled, awaiting, late, checking or held. The summary totals still cover the full period.

Example: late

Possible values: reconciled, awaiting, late, checking, held

Response (200)

Section titled “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}$

totalsobjectrequired

How many payments are in each status, and what they net.

reconciledobjectrequired

Paid and matched with the provider's settlement.

countintegerrequired

Number of payments whose settlement matched during this period.

Example: 12

net_amountintegerrequired

Net amount of the payments whose settlement matched, in the smallest unit of currency (Rp125.000 is 12500000).

Example: 11916000

awaitingobjectrequired

Paid, and the settlement is not due yet.

countintegerrequired

Number of paid payments still waiting for their expected settlement.

Example: 3

net_amountintegerrequired

Net amount of paid payments still waiting for settlement, in the smallest unit of currency (Rp125.000 is 12500000).

Example: 2979000

lateobjectrequired

Paid, and the settlement should have come by now.

countintegerrequired

Number of paid payments whose expected settlement date has passed.

Example: 0

net_amountintegerrequired

Net amount of paid payments past their expected settlement date, in the smallest unit of currency (Rp125.000 is 12500000).

Example: 0

checkingobjectrequired

Being checked by Baiyar because something did not add up.

countintegerrequired

Number of payments Baiyar is checking because the settlement did not match.

Example: 0

net_amountintegerrequired

Net amount of payments Baiyar is checking against the settlement, in the smallest unit of currency (Rp125.000 is 12500000).

Example: 0

heldobjectrequired

Held back until a decision is recorded.

countintegerrequired

Number of payments held while a settlement issue is reviewed.

Example: 0

net_amountintegerrequired

Net amount of payments held while a settlement issue is reviewed, in the smallest unit of currency (Rp125.000 is 12500000).

Example: 0

rowsarray of objectrequired

Every paid payment of the period with where its settlement stands.

payment_idstringrequired

The id of the payment.

Example: pay_01k7q3m8x2v5t9n4b6c1d0e7fa

Prefixed with pay_.

project_idstringrequired

The project this object belongs to. Its settings determine which payment methods and limits apply.

Example: prj_01k7q3m8x2v5t9n4b6c1d0e7fa

Prefixed with prj_.

merchant_referencestring | nullrequired

Your reference for the payment; null when it has none.

Example: order-1001

provider_codestringrequired

The payment provider that carried the payment.

Example: singapay

payment_methodstringrequired

The payment method, for example payment.qris or payment.va.bca.

Example: payment.qris

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_atstringrequired

When the payment was paid (RFC 3339, UTC).

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

Format: date-time

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

statusstringrequired

reconciled, awaiting, late, checking or held.

Example: reconciled

Possible values: reconciled, awaiting, late, checking, held

settled_atstring | nullrequired

When the provider settled it; null until then.

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

Format: date-time

settlement_roundintegerrequired

Which settlement round included this payment. The number increases if a settlement is reversed and matched again; null when the provider does not use rounds.

Example: 1

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.

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