Payment Cancel
Membatalkan invoice yang berstatus PENDING. Setelah dibatalkan, status transaksi akan berubah menjadi CANCELLED.
Harap dicatat bahwa hanya invoice dengan status PENDING yang dapat dibatalkan. Invoice yang sudah berstatus PAID, EXPIRED, atau CANCELLED tidak dapat dibatalkan kembali.
Jika pelanggan masih ingin melanjutkan pembayaran, silakan buat invoice baru dengan payment_code yang berbeda.
Request
- Endpoint
- Parameter
- Header
- Body
- Contoh
| Method | URL |
|---|---|
DELETE | https://api.bayar.digital/gateway/payments/{payment_code} |
| Parameter | Tipe | Wajib | Deskripsi |
|---|---|---|---|
payment_code | string | Ya | Kode invoice dari sistem Anda |
| Header | Wajib | Deskripsi |
|---|---|---|
X-Api-Key | Ya | API Key merchant Anda |
| Field | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| Tidak ada body pada request ini. | |||
curl -X DELETE https://api.bayar.digital/gateway/payments/INV-2026-0001 \
-H "X-Api-Key: pk_..."
Response
- Sukses
- Gagal
| Field | Tipe | Deskripsi |
|---|---|---|
success | bool | true |
message | string | "ok" |
data | null | Selalu null |
200 OK
{
"success": true,
"message": "ok",
"data": null
}
| Code | Status | Keterangan |
|---|---|---|
tenant_api_key_required | 403 | API Key tidak valid atau tidak disertakan |
payment_not_cancellable | 404 | Invoice tidak ditemukan atau statusnya bukan PENDING |
internal_error | 500 | Terjadi kendala pada server, silakan coba beberapa saat lagi |
404 Not Found
{
"success": false,
"code": "payment_not_cancellable",
"message": "payment not found or not pending"
}