Dokumentasi › API V1

Daftar Channel

Mengambil channel pembayaran yang bisa dipakai beserta batas nominalnya.

GET/v1/channels
Berlaku diSandbox (zp_test_)Live (zp_live_)

Mengambil channel pembayaran yang aktif. Gunakan code sebagai nilai channel saat membuat pembayaran. Di mode live, semua channel aktif ditampilkan seperti di halaman Channel dashboard, termasuk yang sedang tidak bisa Anda pakai (lihat available). Di sandbox, semua channel aktif selalu tersedia.

Contoh kode

cURL
curl https://api-sandbox.zevalpay.com/v1/channels \
  -H "Authorization: Bearer zp_test_KUNCI_ANDA"
PHP
<?php
$result = zevalpay('GET', '/v1/channels');

foreach ($result['data'] as $channel) {
    echo $channel['code'] . ' - ' . $channel['label'] . PHP_EOL;
}
Node.js
const result = await zevalpay('GET', '/v1/channels');

for (const channel of result.data) {
  console.log(channel.code, '-', channel.label);
}

Fungsi zevalpay() pada contoh adalah pembungkus tipis yang menambahkan header Authorization. Lihat Buat Pembayaran untuk contoh lengkapnya.

Contoh respons

Berhasil
HTTP 200
{
  "data": [
    {
      "code": "qris",
      "label": "QRIS",
      "group": "qris",
      "logo_url": "https://zevalpay.com/uploads/channels/qris.png",
      "description": "<p>Cara Pembayaran via QRIS</p><ol><li>Buka aplikasi bank atau e-wallet.</li><li>Pilih menu Scan QR.</li></ol>",
      "available": true,
      "maintenance": false,
      "min_amount": 1000,
      "max_amount": 10000000,
      "expiry_minutes": 60,
      "fee": { "percent": 0.7, "fixed": 0 },
      "settlement_days": 0
    },
    {
      "code": "va_bca",
      "label": "VA BCA",
      "group": "va",
      "logo_url": "https://zevalpay.com/uploads/channels/va_bca.png",
      "description": null,
      "available": true,
      "maintenance": false,
      "min_amount": 10000,
      "max_amount": 10000000,
      "expiry_minutes": 1440,
      "fee": { "percent": 0.7, "fixed": 500 },
      "settlement_days": 1
    }
  ]
}

Isi data

ParameterTipeKeterangan
codestringKode channel. Dipakai sebagai channel saat membuat pembayaran.
labelstringNama yang bisa ditampilkan kepada pembeli.
groupstringKelompok: qris, va (virtual account), ewallet, atau retail.
logo_urlstringAlamat gambar logo channel, atau null bila belum ada. Logo adalah merek dagang pemiliknya, pakai hanya untuk menampilkan pilihan bayar.
descriptionstringPetunjuk bayar channel dalam HTML siap tampil yang sudah disaring, termasuk judulnya. Tampilkan apa adanya kepada pembeli. Bernilai null bila belum ditulis.
availablebooleantrue bila channel bisa dipakai sekarang. Bila false (dimatikan untuk merchant Anda, belum siap, atau sedang pemeliharaan), membuat pembayaran dengan channel ini ditolak.
maintenancebooleantrue bila channel tidak tersedia karena pemeliharaan (sementara, akan dibuka kembali). Selalu disertai available false. Channel yang dimatikan untuk Anda atau belum siap tetap false.
min_amountintegerNominal minimum dalam rupiah.
max_amountintegerNominal maksimum dalam rupiah.
expiry_minutesintegerMasa berlaku bawaan dalam menit. Batas atas yang boleh Anda minta.
fee.percentnumberBiaya dalam persen dari nominal, mis. 0.7 = 0,7%.
fee.fixedintegerBiaya tetap dalam rupiah, ditambahkan ke biaya persen. Boleh 0.
settlement_daysintegerKapan dana masuk saldo tersedia: 0 = langsung saat dibayar, 1 sampai 3 = hari kerja ke-N setelah dibayar.

Kode channel yang umum

KelompokKode
qrisqris
vava_bca va_bni va_bri va_mandiri va_permata va_cimb va_bsi va_danamon va_maybank va_bnc va_muamalat va_ocbc
ewalletew_ovo ew_dana ew_shopeepay ew_linkaja ew_gopay
retailrt_alfamart rt_indomaret
Menghitung biayaBiaya yang dipotong = nominal × percent ÷ 100 dibulatkan ke atas ke rupiah penuh, ditambah fixed. Contoh VA BCA Rp 100.000 dengan 0,7% + Rp 500 = Rp 1.200, jadi yang masuk saldo Rp 98.800. Angka ini sudah memakai tarif khusus untuk merchant Anda bila ada. Di sandbox biaya selalu 0 dan dana langsung tersedia.
Pemeliharaan terjadwalBeberapa channel (mis. QRIS) punya jam pemeliharaan harian di penyedianya. Selama itu, dan selama admin menutup channel secara manual, channel tetap muncul di daftar dengan available: false dan maintenance: true, jadi Anda bisa menonaktifkan tombolnya dan menampilkan "sedang pemeliharaan". Bila ada penyedia pengganti, channel tetap available: true dan pembayaran dialihkan otomatis tanpa perubahan biaya.
Selalu ambil dari endpoint iniChannel bisa ditambah atau dinonaktifkan, dan batas nominalnya bisa berubah. Jangan menulis daftar di atas secara tetap di sistem Anda.