Zum Inhalt springen

API

Auf dieser Seite

Sperren

Einem Zahlungskanal keine neuen Einzahlungen mehr zuordnen, ohne ihn zu löschen, seine Adressen freizugeben oder bereits eingegangene Zahlungen anzutasten.

POST/v1/payment-channels/:payment_channel_id/block

API-Schlüssel: Payment

Über das Sperren legen Sie einen Kanal still. Löschen gibt es nicht: Eine Adresse, die ein Kunde gespeichert hat, darf nie jemand anderem gehören. Der Datensatz bleibt also, die Wege bleiben auch, und Sie werden über sie schlicht nicht mehr gutgeschrieben.

Kein Anfragekörper.

Was das Sperren bewirkt

  • —Neue Einzahlungen werden diesem Kanal nicht mehr zugeordnet.
  • —status wird blocked, is_accepting_payments wird false.
  • —Adressen werden nicht freigegeben und nicht neu vergeben. Sie bleiben für immer die dieses Kanals.
  • —Bereits eingegangene Einzahlungen bleiben unberührt. Eine Einzahlung, die beim Sperren noch auf confirming steht, erreicht weiterhin confirmed, wird verbucht, löst ihren Webhook aus und erscheint im Feed.
  • —Die Bereitstellung läuft weiter. Netzwerke, die noch eingerichtet wurden, machen weiter, sodass ein späteres Entsperren Ihnen einen vollständig fertigen Kanal zurückgibt.

Ein erneuter Aufruf auf einem bereits gesperrten Kanal bewirkt nichts und gibt denselben Kanal mit 200 OK zurück.

Antwort (200 OK)

Das vollständige Kanalobjekt, in derselben Form, die Abrufen liefert, mit status nun auf blocked und is_accepting_payments nun auf false. Jedes andere Feld bleibt unverändert, einschließlich des gesamten networks-Arrays.

Fehler

Code HTTP Wann
payment_channels_disabled 503 Zahlungskanäle sind für Ihr Konto in dieser Umgebung nicht freigeschaltet.
payment_key_required 403 Die Anfrage wurde mit einem Payout-Schlüssel (rk_) signiert.
payment_channel_not_found 404 Die Kennung führt zu nichts, was diese Zugangsdaten sehen dürfen.
field_invalid_format 400 Das Pfadsegment ist keine gültige pc_-Kennung.

Den vollständigen Katalog finden Sie unter Fehlercodes; rückgängig macht das Entsperren.

Zahlungskanal abrufen Zahlungskanal entsperren