Lihat settlement

GET/v1/reports/settlementsJalankan

Membutuhkan izin balances:read.

Parameter query

fromstringwajib

Hari pertama periode, YYYY-MM-DD waktu Jakarta. Hari itu ikut dihitung.

Contoh: 2026-10-01

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

tostringwajib

Hari terakhir periode, YYYY-MM-DD waktu Jakarta. Hari itu ikut dihitung.

Contoh: 2026-10-26

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

Respons (200)

dataobjectwajib

Objek yang dikembalikan, atau array objek untuk operasi daftar.

livemodebooleanwajib

true berarti objek ini ada di live dan bisa melibatkan pembayaran sungguhan; false berarti objek ini ada di sandbox.

currencystringwajib

Mata uang, kode ISO 4217. Saat ini hanya IDR.

Contoh: IDR

Nilai: IDR

fromstringwajib

Hari pertama periode, YYYY-MM-DD waktu Jakarta. Hari itu ikut dihitung.

Contoh: 2026-10-01

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

tostringwajib

Hari terakhir periode, YYYY-MM-DD waktu Jakarta. Hari itu ikut dihitung.

Contoh: 2026-10-26

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

daysarray dari objectwajib

Satu baris untuk setiap hari kerja yang punya pembayaran lunas.

business_daystringwajib

Tanggal Jakarta untuk mengelompokkan pembayaran atau pencatatan saldo ini, YYYY-MM-DD.

Contoh: string

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

paid_countintegerwajib

Berapa pembayaran yang lunas hari itu.

Contoh: 5

charged_amountintegerwajib

Total yang dibayar pembayar, termasuk biaya jika ditanggung pembayar, dalam satuan terkecil currency (Rp125.000 adalah 12500000).

Contoh: 1000000

fee_amountintegerwajib

Biaya Baiyar untuk pembayaran ini, dalam satuan terkecil currency (Rp125.000 adalah 12500000).

Contoh: 7000

net_amountintegerwajib

Nominal yang dikreditkan setelah biaya Baiyar, dalam satuan terkecil currency (Rp125.000 adalah 12500000).

Contoh: 993000

settled_countintegerwajib

Berapa di antaranya yang sudah di-settle penyedia.

Contoh: 5

settled_net_amountintegerwajib

Nominal bersih pembayaran hari itu yang sudah cocok dengan settlement penyedia, dalam satuan terkecil currency (Rp125.000 adalah 12500000).

Contoh: 4965000

statusstringwajib

awaiting (belum ada yang di-settle), partial, atau settled (semua di-settle).

Contoh: settled

Nilai yang mungkin: awaiting, partial, settled

last_settled_atstring | nullwajib

Waktu pembayaran terakhir di baris ini dicocokkan dengan settlement penyedia; null jika belum ada yang di-settle.

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

Format: date-time

metaobjectwajib

Detail request seperti id dan kursor paginasi.

request_idstringwajib

Id request ini. Sebutkan saat bertanya ke dukungan.

Contoh: req_Hy3k9QzT2LmN8vXa

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

Request

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

Respons

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