Bagian 9

Settlement, kanal, dan laporan

Settlement, daftar kanal dan bank, serta ekspor laporan CSV/XLSX.

Settlement

GET/api/v1/settlementssettlements:readRespons 200

Filter: status, type, reference, from, to, cursor, limit; tanggal memfilter created_at.

FieldNilai
typePAYIN_RELEASE untuk pelepasan saldo dan PAYOUT_COMPLETION untuk catatan penyelesaian payout.
statusWAITING_FUNDS, COMPLETED, atau NEEDS_REVIEW.
Response 200
{
  "data": [
    {
      "id": "set_example_001",
      "type": "PAYIN_RELEASE",
      "status": "COMPLETED",
      "reference": "ORDER-0001",
      "resource_id": "pin_example_001",
      "gross": "100000",
      "fee": "1500",
      "net": "98500",
      "currency": "IDR",
      "journal_group_id": "jg_example_payin",
      "created_at": "2026-10-15T05:02:00Z",
      "completed_at": "2026-10-15T05:02:00Z"
    }
  ],
  "pagination": { "next_cursor": null, "has_more": false },
  "request_id": "req_example_008"
}

Settlement payout tidak mendebit saldo lagi. Penyelesaian dana provider dapat tertunda walaupun pelanggan sudah membayar; gunakan available untuk mengetahui jumlah yang dapat dipayout. Detail pencocokan operasional dapat dilihat melalui dashboard.

Kanal dan rekening tujuan

GET/api/v1/channelschannels:readRespons 200

Respons data berupa array item dengan field berikut.

FieldKeterangan
codeKode kanal. Kode kanal payout v1 adalah BANK_PAYOUT; route otomatis atau manual ditentukan AntaraPay.
operationPAYIN atau PAYOUT.
statusAVAILABLE, DEGRADED, atau UNAVAILABLE.
min_amount / max_amountBatas nominal per transaksi.
currencyIDR.
bank_codesKode bank yang didukung kanal.
estimated_ready_secondsEstimasi kesiapan instruksi; dapat null.
Nilai limit dan bank_codes diberikan oleh konfigurasi aktif. Daftar kanal dapat berubah dan tidak menjamin slot tersedia ketika POST dikirim. Client harus tetap menangani CHANNEL_UNAVAILABLE dan RATE_LIMITED.

Ekspor laporan

POST/api/v1/reports/exportsreports:writeRespons 202
FieldWajibKeterangan
typeYaPAYINS, PAYOUTS, JOURNALS, atau SETTLEMENTS.
formatYaCSV atau XLSX.
from / toYaRentang waktu RFC 3339 UTC. Rentang maksimum rancangan 31 hari.
date_fieldTidakSesuai jenis laporan: payin created_at/paid_at, payout created_at/completed_at, jurnal posted_at, settlement created_at/completed_at.
Response 202
{
  "data": { "id": "exp_example_001", "status": "QUEUED" },
  "request_id": "req_example_009"
}
GET/api/v1/reports/exports/{id}reports:readRespons 200

data memuat id, status (QUEUED, PROCESSING, READY, atau FAILED), format, download_url, expires_at, dan error_code nullable. URL hanya tersedia saat READY, bersifat privat dan berumur pendek. Jika expired, ambil status lagi untuk URL baru selama file masih dalam masa retensi. Ekspor tidak membuat transaksi keuangan.