Hapus dan batalkan

Objek mana yang bisa dihapus, dibatalkan, atau dicabut, dan caranya.

API menyediakan aksi berbeda untuk mengakhiri tiap objek. Tabel ini menunjukkan aksi yang tersedia dan batasnya.

Ringkasan

Objek	Yang bisa dilakukan	Caranya
Pembayaran	Batalkan selama belum ada yang membayar: ia berakhir sebagai `failed`. Selain itu ia berakhir sendiri sebagai `paid`, `failed`, atau `expired`	Batalkan pembayaran; ikuti dengan Lihat pembayaran atau webhook
Payment link	Batalkan: tidak ada pembayaran baru, dan pembayaran yang sudah ada tetap	Batalkan payment link
Invoice	Hapus draf; batalkan yang sudah terbit (tidak setelah dibayar atau sedang dibayar). Nomornya tetap terpakai	Hapus invoice draf, Batalkan invoice
Endpoint webhook	Hapus: event tidak lagi dikirim ke sana	Hapus endpoint webhook
API key	Cabut: request dengan key itu langsung berhenti bekerja dan tidak bisa dibatalkan	Dashboard, lihat Ambil API key
Proyek	Nonaktifkan: pembayaran baru tidak diterima sampai kamu mengaktifkannya lagi	Dashboard, lihat Buat proyek

Membatalkan payment link

curl -X POST "https://api.baiyar.com/v1/payment-links/lnk_01k7q3m8x2v5t9n4b6c1d0e7fa/cancel" \
  -H "Authorization: Bearer $BAIYAR_KEY" \
  -H "Idempotency-Key: cancel-invoice-2041"

Jawabannya adalah link seperti keadaannya sekarang, di data, dengan state: "cancelled" dan cancelled_at. Pembayar yang membukanya tidak bisa membayar lagi. Pembayaran yang sudah dibuat lewat link itu tidak berubah. Kirim request yang sama dengan Idempotency-Key yang sama lagi dan kamu mendapat jawaban yang sama.

Menghapus endpoint webhook

curl -X DELETE "https://api.baiyar.com/v1/webhook-endpoints/whk_01k7q3m8x2v5t9n4b6c1d0e7fa" \
  -H "Authorization: Bearer $BAIYAR_KEY"

{
  "data": { "id": "whk_01k7q3m8x2v5t9n4b6c1d0e7fa", "deleted": true },
  "meta": { "request_id": "req_Hy3k9QzT2LmN8vXa" }
}

Jawabannya menyebut endpoint mana yang hilang. Endpoint yang dihapus tidak bisa dikembalikan: daftarkan lagi, dan kamu mendapat signing secret baru. Untuk menghentikan event tanpa kehilangan endpoint, ubah statusnya dengan Ubah endpoint webhook.

Halaman terkait