Daftar metode pembayaran

GET/v1/payment-methodsJalankan

API key apa pun bisa memanggil ini.

Respons (200)

dataarray dari objectwajib

Objek yang dikembalikan, atau array objek untuk operasi daftar.

codestringwajib

Kode metode, seperti yang kamu kirim di payment_method.

Contoh: payment.va.bca

groupstringwajib

Kategori untuk mengelompokkan metode ini di daftar metode pembayaran: qris, virtual_account, ewallet, retail, atau feature.

Contoh: virtual_account

Nilai yang mungkin: qris, virtual_account, ewallet, retail, feature

feeobject | nullwajib

Biaya Baiyar untuk metode ini. Null bila metode tidak punya biaya sendiri.

currencystringwajib

Mata uang yang dipakai untuk biaya tetap dan tingkatan biaya di bawah ini.

Contoh: IDR

Pola: ^[A-Z]{3}$

flat_amountinteger | nullwajib

Bagian tetap biaya, dalam satuan terkecil currency (Rp125.000 adalah 12500000).

Contoh: 450000

percentnumber | nullwajib

Persentase yang ditambahkan ke biaya tetap; 0.7 berarti 0,7%. Null berarti tidak ada komponen persentase.

Contoh: 0.7

tiersarray dari objectwajib

Aturan biaya menurut nominal. Biaya dasar berlaku sampai nominal melewati above_amount; setelah itu nilai tetap dan persentase pada tingkat tersebut yang berlaku.

above_amountintegerwajib

Ambang yang harus dilewati agar tingkat biaya ini berlaku, dalam satuan terkecil currency (Rp125.000 adalah 12500000).

Contoh: 10000000

flat_amountinteger | nullwajib

Bagian tetap biaya pada tahap ini, dalam satuan terkecil currency (Rp125.000 adalah 12500000).

Contoh: 0

percentnumber | nullwajib

Persentase yang ditambahkan ke biaya tetap pada tingkat ini; 0.7 berarti 0,7%.

Contoh: 0.7

settlement_daysinteger | nullwajib

Perkiraan hari setelah pembayaran sampai dana masuk ke saldo tersedia. Null jika belum ada perkiraan.

Contoh: 1

statestringwajib

enabled, atau not_eligible bila akunmu belum bisa memakainya di live. Test key bisa mencoba semua metode.

Contoh: enabled

Nilai yang mungkin: enabled, not_eligible

reasonsarray dari stringwajib

Jika state adalah not_eligible, kode-kode ini menjelaskan kenapa metode belum tersedia untuk akun ini. Kosong berarti tidak ada masalah kelayakan.

switched_off_bystring | nullwajib

Saklar yang kamu matikan dan menutup metode ini (kodenya sendiri atau keluarganya); null bila tidak ada.

Contoh: string

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/payment-methods" \
  -H "Authorization: Bearer $BAIYAR_KEY"

Respons

{
  "data": [
    {
      "code": "payment.va.bca",
      "group": "virtual_account",
      "fee": {
        "currency": "IDR",
        "flat_amount": 450000,
        "percent": 0.7,
        "tiers": [
          {
            "above_amount": 10000000,
            "flat_amount": 0,
            "percent": 0.7
          }
        ]
      },
      "settlement_days": 1,
      "state": "enabled",
      "reasons": [
        "SUSPENDED"
      ],
      "switched_off_by": "string"
    }
  ],
  "meta": {
    "request_id": "req_Hy3k9QzT2LmN8vXa"
  }
}