Lewati ke konten

Filter daftar

Filter setiap operasi daftar, dan cara daftar diurutkan.


Filter adalah query parameter dari operasi daftar. Filter digabung: sebuah item harus cocok dengan semuanya. Daftar selalu terbaru dahulu; tidak ada parameter pengurutan.

Operasi Filter
GET /v1/payments status, project_id, merchant_reference, payment_method, payment_link_id, q (id pembayaran, atau awal referensimu), from dan to (hari YYYY-MM-DD waktu Jakarta, keduanya termasuk)
GET /v1/webhook-deliveries endpoint_id, payment_id, status (pending, retrying, succeeded, failed)
GET /v1/invoices project_id, status, q (nomor, atau sebagian nama atau email pelanggan)
GET /v1/payment-links project_id, state, q (cari menurut judul atau referensi)
GET /v1/events type (sebuah jenis seperti payment.succeeded, atau keluarga seperti payment.*), project_id, payment_id, payment_link_id
GET /v1/webhook-endpoints project_id
GET /v1/balance/movements account (pending atau available)

Nilai yang diterima tiap filter ada di halaman operasinya, di referensi API.

Pembayaran lunas untuk satu order:

Terminal window
curl "https://api.baiyar.com/v1/payments?status=paid&merchant_reference=order-1001" \
-H "Authorization: Bearer $BAIYAR_KEY"

Semua event satu pembayaran, untuk melihat apa yang terjadi padanya:

Terminal window
curl "https://api.baiyar.com/v1/events?payment_id=pay_01k7q3m8x2v5t9n4b6c1d0e7fa" \
-H "Authorization: Bearer $BAIYAR_KEY"

Hanya event pembayaran (sebuah keluarga), dalam 30 hari event disimpan:

Terminal window
curl "https://api.baiyar.com/v1/events?type=payment.*" \
-H "Authorization: Bearer $BAIYAR_KEY"

Gunakan filter yang sama pada setiap request halaman. Kursor melanjutkan daftar dengan filter tersebut. Lihat Paginasi.