Daftar payment link

Menampilkan payment link yang bisa diakses API key ini, terbaru dahulu.

GET/v1/payment-links

Membutuhkan izin payments:read.

Parameter query

project_idstringopsional

Hanya link proyek ini.

Contoh: prj_01k7q3m8x2v5t9n4b6c1d0e7fa

Diawali prj_.

statestringopsional

Hanya link dengan status ini.

Contoh: payable

Nilai yang mungkin: payable, in_use, completed, cancelled, expired

qstringopsional

Sebagian judul atau referensi.

Contoh: Kopi

Panjang minimum: 1

Panjang maksimum: 100

starting_afterstringopsional

Id item terakhir di halaman yang sudah kamu punya. Halaman berikutnya dimulai setelah item itu.

Contoh: lnk_01k7q3m8x2v5t9n4b6c1d0e7fa

Diawali lnk_.

limitintegeropsional

Jumlah item per halaman, dari 1 sampai 100. Bawaannya 20.

Contoh: 20

Minimum: 1

Maksimum: 100

Respons (200)

Mengembalikan satu halaman daftar: data berisi item, dan meta.pagination menunjukkan kelanjutannya. Halaman berikutnya dengan limit dan starting_after (id item terakhir yang sudah kamu punya), atau ambil meta.pagination.next.

dataarray dari objectwajib

Objek yang dikembalikan, atau array objek untuk operasi daftar.

idstringwajib

Id payment link (lnk_…).

Contoh: lnk_01k7q3m8x2v5t9n4b6c1d0e7fa

Diawali lnk_.

livemodebooleanwajib

true berarti objek ini ada di live dan bisa melibatkan pembayaran sungguhan; false berarti objek ini ada di sandbox.

project_idstringwajib

Proyek tempat objek ini berada. Pengaturannya menentukan metode pembayaran dan batas yang berlaku.

Contoh: prj_01k7q3m8x2v5t9n4b6c1d0e7fa

Diawali prj_.

urlstringwajib

Alamat checkout untuk link ini. Bagikan ke pembayar agar mereka bisa memilih metode dan membayar.

Contoh: https://pay.baiyar.com/p/lt_live_…

titlestringwajib

Nama yang ditampilkan kepada pembayar, misalnya nama produk atau nomor invoice.

Contoh: Paket Kopi Senja

descriptionstring | nullwajib

Catatan lebih panjang di halaman bayar; opsional.

Contoh: Dua bungkus biji kopi 250 gram.

referencestringwajib

Referensimu sendiri untuk link ini. Dibuatkan bila dikosongkan.

Contoh: INV-2041

statestringwajib

payable, in_use (ada pembayaran berjalan), completed, cancelled, atau expired.

Contoh: payable

Nilai yang mungkin: payable, in_use, completed, cancelled, expired

amount_modestringwajib

fixed (kamu menetapkan nominal) atau open (pembayar mengisinya antara minimum dan maksimum).

Contoh: fixed

Nilai yang mungkin: fixed, open

amountinteger | nullwajib

Nominal dasar tiap pembayaran sebelum biaya, dalam satuan terkecil currency (Rp125.000 adalah 12500000).

Contoh: 2500000

min_amountinteger | nullwajib

Nominal minimum yang bisa diisi pembayar untuk link dengan nominal terbuka, dalam satuan terkecil currency (Rp125.000 adalah 12500000).

Contoh: 1000000

max_amountinteger | nullwajib

Nominal maksimum yang bisa diisi pembayar untuk link dengan nominal terbuka, dalam satuan terkecil currency (Rp125.000 adalah 12500000).

Contoh: 100000000

currencystringwajib

Mata uang, kode ISO 4217. Saat ini hanya IDR.

Contoh: IDR

Nilai: IDR

usagestringwajib

single_use menerima satu pembayaran; reusable menerima beberapa pembayaran. Bawaannya single_use.

Contoh: single_use

Nilai yang mungkin: single_use, reusable

max_usesinteger | nullwajib

Jumlah maksimum pembayaran yang sedang berjalan atau sudah lunas sebelum link berhenti menerima pembayaran baru. Null berarti tanpa batas.

Contoh: 1

fee_bearerstringwajib

Siapa yang menanggung biaya Baiyar: merchant memotongnya dari yang kamu terima, customer menambahkannya ke yang dibayar pembayar.

Contoh: merchant

Nilai yang mungkin: merchant, customer

customer_fieldsobjectwajib

Mengatur data yang diminta checkout dari pembayar. Field yang tidak disebutkan bawaannya off.

namestringwajib

Apakah checkout meminta nama pembayar: off, optional (boleh dikosongkan), atau required.

Contoh: required

Nilai yang mungkin: off, optional, required

emailstringwajib

Apakah checkout meminta email pembayar: off, optional (boleh dikosongkan), atau required.

Contoh: required

Nilai yang mungkin: off, optional, required

phonestringwajib

Apakah checkout meminta nomor telepon pembayar: off, optional (boleh dikosongkan), atau required.

Contoh: off

Nilai yang mungkin: off, optional, required

addressstringwajib

Apakah checkout meminta alamat pembayar: off, optional (boleh dikosongkan), atau required.

Contoh: off

Nilai yang mungkin: off, optional, required

expires_atstring | nullwajib

Kapan link berhenti menerima pembayaran; null berarti tanpa batas waktu.

Contoh: 2026-10-26T03:04:05.000Z

Format: date-time

redirect_urlstring | nullwajib

Ke mana pembayar pergi setelah membayar, bila after_payment adalah redirect. Harus HTTPS.

Contoh: https://toko.example.com/terima-kasih

after_paymentstringwajib

confirmation menampilkan halaman konfirmasi Baiyar; redirect mengarahkan pembayar ke redirect_url. Bawaannya confirmation.

Contoh: confirmation

Nilai yang mungkin: confirmation, redirect

confirmation_messagestring | nullwajib

Kata-katamu sendiri di halaman konfirmasi; opsional.

Contoh: Terima kasih! Pesananmu dikirim dalam 2 hari.

methodsarray dari objectwajib

Metode link beserta aturan biaya yang dikunci saat link dibuat.

payment_methodstringwajib

Metode pembayaran yang ditawarkan link ini, misalnya QRIS atau virtual account BCA.

Contoh: payment.qris

feeobjectwajib

Aturan biaya yang dikunci di link; perubahan harga nanti tidak memengaruhinya.

flat_amountinteger | nullwajib

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

Contoh: 25000

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. Tingkat biaya berlaku hanya jika nominal pembayaran melewati ambang above_amount.

above_amountintegerwajib

Tahap ini berlaku untuk nominal di atas ini, 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

Hari setelah pembayaran sampai uang tersedia.

Contoh: 1

previewobject | nullwajib

Perkiraan biaya metode pada nominal link; null untuk link yang nominalnya diisi pembayar.

amountintegerwajib

Nominal dasar untuk menghitung perkiraan biaya metode ini, sebelum biaya, dalam satuan terkecil currency (Rp125.000 adalah 12500000).

Contoh: 2500000

fee_amountintegerwajib

Perkiraan biaya Baiyar untuk metode dan nominal ini, dalam satuan terkecil currency (Rp125.000 adalah 12500000).

Contoh: 42500

charged_amountintegerwajib

Total perkiraan yang dibayar pembayar, termasuk biaya jika ditanggung pembayar, dalam satuan terkecil currency (Rp125.000 adalah 12500000).

Contoh: 2500000

net_amountintegerwajib

Perkiraan nominal yang masuk ke saldo setelah biaya Baiyar, dalam satuan terkecil currency (Rp125.000 adalah 12500000).

Contoh: 2457500

statsobjectwajib

Jumlah pembayaran dan penerimaan bersih yang tercatat untuk link ini.

paid_countintegerwajib

Jumlah pembayaran melalui link ini yang sudah berstatus paid.

Contoh: 1

open_countintegerwajib

Jumlah pembayaran melalui link ini yang masih menunggu pembayar.

Contoh: 0

paid_net_amountintegerwajib

Nilai bersih yang sudah lunas, dalam satuan terkecil currency (Rp125.000 adalah 12500000).

Contoh: 2457500

cancelled_atstring | nullwajib

Kapan dibatalkan; null bila tidak.

Contoh: 2026-10-26T03:04:05.000Z

Format: date-time

created_atstringwajib

Waktu objek ini dibuat (RFC 3339, UTC). Gunakan untuk mengurutkan objek berdasarkan waktu pembuatan.

Contoh: 2026-10-26T03:04:05.000Z

Format: date-time

metaobjectwajib

Detail request seperti id dan kursor paginasi.

request_idstringwajib

Id request ini. Sebutkan saat bertanya ke dukungan.

Contoh: req_Hy3k9QzT2LmN8vXa

paginationobjectwajib

Detail paginasi untuk respons daftar. Gunakan next untuk mengambil halaman berikutnya, atau starting_after untuk menyusun URL sendiri.

per_pageintegerwajib

Jumlah item yang dikembalikan di halaman ini.

Contoh: 20

has_morebooleanwajib

true berarti masih ada item di halaman berikutnya.

nextstring | nullwajib

Alamat halaman berikutnya, dengan filtermu tetap; null di halaman terakhir.

Contoh: string

Request yang gagal dijawab dengan bentuk error yang sama; lihat Error.

Request
Respons

curl "https://api.baiyar.com/v1/payment-links" \
  -H "Authorization: Bearer $BAIYAR_KEY"

{
  "data": [
    {
      "id": "lnk_01k7q3m8x2v5t9n4b6c1d0e7fa",
      "livemode": false,
      "project_id": "prj_01k7q3m8x2v5t9n4b6c1d0e7fa",
      "url": "https://pay.baiyar.com/p/lt_live_…",
      "title": "Paket Kopi Senja",
      "description": "Dua bungkus biji kopi 250 gram.",
      "reference": "INV-2041",
      "state": "payable",
      "amount_mode": "fixed",
      "amount": 2500000,
      "min_amount": 1000000,
      "max_amount": 100000000,
      "currency": "IDR",
      "usage": "single_use",
      "max_uses": 1,
      "fee_bearer": "merchant",
      "customer_fields": {
        "name": "required",
        "email": "required",
        "phone": "off",
        "address": "off"
      },
      "expires_at": "2026-10-26T03:04:05.000Z",
      "redirect_url": "https://toko.example.com/terima-kasih",
      "after_payment": "confirmation",
      "confirmation_message": "Terima kasih! Pesananmu dikirim dalam 2 hari.",
      "methods": [
        {
          "payment_method": "payment.qris",
          "fee": {
            "flat_amount": 25000,
            "percent": 0.7,
            "tiers": [
              {
                "above_amount": 10000000,
                "flat_amount": 0,
                "percent": 0.7
              }
            ]
          },
          "settlement_days": 1,
          "preview": {
            "amount": 2500000,
            "fee_amount": 42500,
            "charged_amount": 2500000,
            "net_amount": 2457500
          }
        }
      ],
      "stats": {
        "paid_count": 1,
        "open_count": 0,
        "paid_net_amount": 2457500
      },
      "cancelled_at": "2026-10-26T03:04:05.000Z",
      "created_at": "2026-10-26T03:04:05.000Z"
    }
  ],
  "meta": {
    "request_id": "req_Hy3k9QzT2LmN8vXa",
    "pagination": {
      "per_page": 20,
      "has_more": true,
      "next": "https://api.baiyar.com/v1/payment-links?starting_after=lnk_01k7q3m8x2v5t9n4b6c1d0e7fa"
    }
  }
}