Zum Inhalt springen

API

Auf dieser Seite

Stornieren

Eine offene Rechnung stornieren, bevor der Kunde ein Asset festlegt — mit dem erlaubten Zustandsübergang und der Behandlung der Antwort.

POST/v1/invoices/:invoice_id/cancel

API-Schlüssel: Payment

Storniert eine Rechnung, die noch im Status awaiting_client steht. Sobald der Kunde Token und Netzwerk gewählt hat und die Rechnung nach awaiting_payment wechselt, ist eine Stornierung nicht mehr möglich — und eine bezahlte oder abgelaufene Rechnung lässt sich nie stornieren. Eine bereits stornierte Rechnung erneut zu stornieren bleibt folgenlos: Der Aufruf gibt 200 mit derselben Rechnung zurück, keinen Fehler.

Anfragekörper

reason ist erforderlich (höchstens 500 Zeichen). Der Grund wird im Prüfprotokoll festgehalten und mit dem Webhook invoice.cancelled übertragen.

{
  "reason": "Customer requested cancellation"
}

Antwort (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
}

Fehler

Den vollständigen Katalog finden Sie unter Fehlercodes. Die type-URI in jeder Fehlerantwort verweist direkt auf die passende Zeile.

Rechnung abrufen Rechnungszahlung simulieren