Dokumentasi › API V1

Daftar Pembayaran

Menelusuri pembayaran dengan filter dan halaman.

POST/v1/payments/list
Berlaku diSandbox (zp_test_)Live (zp_live_)

Menelusuri pembayaran, urut dari yang terbaru. Hanya pembayaran sesuai mode kunci yang tampil. Semua isian bersifat opsional dan bisa digabung. Body kosong {} berarti semua pembayaran, 25 per halaman.

Yang perlu dikirim

Body JSON.

ParameterTipeWajibKeterangan
statusstringTidakpending, paid, failed, atau expired.
channelstringTidakKode channel, mis. qris.
created_from, created_tostringTidakTanggal tagihan dibuat, format YYYY-MM-DD (waktu Jakarta). Kedua tanggal inklusif dan harus diisi berpasangan. Maksimal 31 hari.
paid_from, paid_tostringTidakTanggal pembayaran diterima, format YYYY-MM-DD (waktu Jakarta). Kedua tanggal inklusif dan harus diisi berpasangan. Maksimal 31 hari. Cocok untuk rekonsiliasi dengan dana yang masuk.
pageintegerTidakNomor halaman, mulai dari 1. Bawaan 1.
limitintegerTidakJumlah per halaman, 1 sampai 100. Bawaan 25.
Mencari satu pembayaranUntuk mencari lewat nomor order Anda, pakai Status Pembayaran dengan merchant_ref. Endpoint ini untuk menelusuri banyak pembayaran.

Contoh filter tanggal

Isi body untuk kebutuhan yang umum. Tanggal memakai waktu Jakarta dan kedua ujungnya masuk dalam rentang.

Pembayaran yang dibuat pada 26 sampai 28 Oktober 2026
Body
{
  "created_from": "2026-10-26",
  "created_to": "2026-10-28"
}
Rekonsiliasi: semua yang dibayar kemarin (28 Oktober 2026)
Body
{
  "status": "paid",
  "paid_from": "2026-10-28",
  "paid_to": "2026-10-28",
  "limit": 100
}
Gabungan: VA BCA yang dibuat selama Oktober, halaman kedua
Body
{
  "channel": "va_bca",
  "created_from": "2026-10-01",
  "created_to": "2026-10-31",
  "page": 2,
  "limit": 50
}
Gagal: tanggal tidak berpasangan
HTTP 422 (juga untuk format salah, rentang terbalik, atau lebih dari 31 hari)
{
  "error": {
    "code": "invalid_request",
    "message": "created_from dan created_to harus diisi berpasangan."
  }
}

Contoh kode

cURL
curl -X POST https://api-sandbox.zevalpay.com/v1/payments/list \
  -H "Authorization: Bearer zp_test_KUNCI_ANDA" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "paid",
    "paid_from": "2026-10-28",
    "paid_to": "2026-10-28",
    "limit": 100
  }'
PHP
<?php
// Rekonsiliasi: semua pembayaran yang dibayar kemarin
$page = 1;
do {
    $result = zevalpay('POST', '/v1/payments/list', [
        'status'    => 'paid',
        'paid_from' => '2026-10-28',
        'paid_to'   => '2026-10-28',
        'limit'     => 100,
        'page'      => $page++,
    ]);

    foreach ($result['data'] as $payment) {
        // cocokkan $payment['merchant_ref'] dengan pesanan Anda
    }
} while ($result['meta']['has_more']);
Node.js
// Rekonsiliasi: semua pembayaran yang dibayar kemarin
let page = 1;
let result;
do {
  result = await zevalpay('POST', '/v1/payments/list', {
    status: 'paid',
    paid_from: '2026-10-28',
    paid_to: '2026-10-28',
    limit: 100,
    page: page++,
  });

  for (const payment of result.data) {
    // cocokkan payment.merchant_ref dengan pesanan Anda
  }
} while (result.meta.has_more);

Contoh respons

Berhasil
HTTP 200 (tiap item dipersingkat)
{
  "data": [
    {
      "reference": "TRX261027K9L0M1",
      "merchant_ref": "INV-1005",
      "status": "pending",
      "channel": "qris",
      "amount": 25000,
      "fee": 0,
      "net_amount": 25000,
      "created_at": "2026-10-27T11:02:10+07:00",
      "paid_at": null,
      "livemode": true
    },
    {
      "reference": "TRX261027H6J7K8",
      "merchant_ref": "INV-1004",
      "status": "paid",
      "channel": "ew_dana",
      "amount": 80000,
      "fee": 560,
      "net_amount": 79440,
      "created_at": "2026-10-27T10:48:33+07:00",
      "paid_at": "2026-10-27T10:49:02+07:00",
      "livemode": true
    }
  ],
  "meta": { "page": 1, "limit": 25, "total": 2, "has_more": false }
}

Setiap elemen data berbentuk sama dengan Status Pembayaran. Lanjutkan membaca halaman berikutnya selama meta.has_more bernilai true.

Kapan memakai endpoint ini?

  • Rekonsiliasi: mencocokkan pembayaran Anda dengan pesanan atau dana yang masuk, mis. semua paid kemarin lewat paid_from dan paid_to. Pakai rentang hari yang sudah lewat agar halaman tidak bergeser saat pembayaran baru masuk.
  • Laporan: menarik pembayaran per periode atau per channel.
  • Untuk satu pembayaran, pakai Status Pembayaran.