Zum Inhalt springen

API

Auf dieser Seite

Stornieren

Eine offene Auszahlung stornieren, bevor die Signatur beginnt — welche Zustände eine Stornierung erlauben und wie die aktualisierte Antwort zu verarbeiten ist.

POST/v1/withdrawals/:withdrawal_id/cancel

API-Schlüssel: Payout

Storniert eine Auszahlung, deren Ausführung noch nicht begonnen hat. Das Zeitfenster schließt sich in dem Moment, in dem Paymos die Auszahlung zu bearbeiten beginnt — und das geschieht, während die Auszahlung noch created ist, bevor irgendetwas signiert wurde. Der Status created allein garantiert also nicht, dass eine Stornierung noch möglich ist: Sobald die Ausführung begonnen hat, liefert der Aufruf 409. Eine bereits stornierte Auszahlung erneut zu stornieren bleibt folgenlos: Der Aufruf gibt 200 mit derselben Auszahlung zurück, keinen Fehler.

Anfragekörper

Senden Sie einen reason (erforderlich, höchstens 500 Zeichen). Paymos speichert ihn an der Auszahlung und schreibt ihn ins Prüfprotokoll. Zurück bekommen Sie ihn nicht: Die Antwort auf die Stornierung und der Webhook withdrawal.cancelled führen den Status, nicht den Grund.

{
  "reason": "Customer requested cancellation"
}

Antwort (200 OK)

{
  "withdrawal_id": "wdr_2M8K6Q4P9X1Z7A3B",
  "external_order_id": "payout-001",
  "status": "cancelled",
  "is_final": true,
  "is_test": true,
  "amount": "100.00",
  "currency": "USDT",
  "network": "TRC20",
  "destination_address": "TN3W4H6rK2ce4vX9YnFQHwKENnHjoxb3m9",
  "created_at": 1739289600,
  "cancelled_at": 1739289660
}

Fehler

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

Auszahlung abrufen Abschluss einer Auszahlung simulieren