İçeriğe atlayın

API

Bu sayfada

İptal

Müşteri bir varlık kilitlemeden önce açık bir faturayı iptal edin, izin verilen durum geçişini öğrenin ve iptal yanıtını işleyin.

POST/v1/invoices/:invoice_id/cancel

API anahtarı: Payment

Hâlâ awaiting_client durumunda olan bir faturayı iptal edin. Müşteri bir token/ağ seçip fatura awaiting_payment durumuna geçtikten sonra iptal artık mümkün değildir — ödenmiş veya süresi dolmuş bir fatura ise asla iptal edilemez. Zaten iptal edilmiş bir faturayı iptal etmek no-op'tur: hata değil, aynı faturayla 200 döndürür.

İstek gövdesi

reason zorunludur (en fazla 500 karakter). Denetim kaydına (audit log) yazılır ve invoice.cancelled webhook'unda taşınır.

{
  "reason": "Customer requested cancellation"
}

Yanıt (200 OK)

{
  "invoice_id": "inv_5CcyDYmMUGtzYL10q0Iimr",
  "project_id": "prj_xFukZuAJZR06pLVBh3uwzv",
  "status": "cancelled",
  "is_final": true,
  "is_test": true,
  "payment_url": "https://checkout.paymos.io/invoice/inv_5CcyDYmMUGtzYL10q0Iimr",
  "order": {
    "external_id": "order-12345",
    "client_id": "customer-67890",
    "amount": "100.00",
    "currency": "USD"
  },
  "created_at": 1739280600,
  "updated_at": 1739280660,
  "expires_at": 1739284200
}

Hatalar

Tam katalog için Hata Kodları bölümüne bakın. Her hata yanıtındaki type URI'si, ilgili satıra doğrudan bağlanır.