Paylink aktualisieren und löschen

Diese Seite erklärt, wie Sie einen bestehenden Paylink ändern und wie Sie ihn entfernen. Das Löschen ist ein einzelner API-Aufruf; Parameteränderungen erfolgen dagegen durch Ersetzen, weil die Merchant API für diese Ressource keine In-place-Aktualisierung anbietet.

Paylink aktualisieren#

Die API-Versionen v1.14 bis v1.16 sehen keine PUT-Operation für die Paylink-Ressource (Invoice) vor: Ein einmal erstellter Paylink kann über die API nicht geändert werden. Um Betrag, Texte oder Ablaufdatum eines noch nicht bezahlten Links zu ändern:

1. Erstellen Sie einen neuen Paylink mit den korrigierten Parametern — siehe Paylink erstellen.
2. Veröffentlichen Sie den neuen Link überall dort, wo der alte geteilt wurde (E-Mail, QR-Code, Rechnungsdokument).
3. Löschen Sie den veralteten Paylink mit dem folgenden Aufruf, damit niemand mehr darüber bezahlen kann.

Paylink löschen#

Das Löschen entfernt den Paylink anhand seiner ID; seine URL akzeptiert danach keine Zahlungen mehr. Authentifizieren Sie sich mit dem Header X-API-KEY — siehe Authentifizierung.

Path-Parameter#

Query-Parameter#

Beispiel-Request#

curl --request DELETE \
  --url "https://api.pay.flowalp.com/v1.16/Invoice/57/?instance=${FLOWALP_PAY_INSTANCE}" \
  --header "X-API-KEY: ${FLOWALP_PAY_API_SECRET}"

<?php
use FlowAlpPay\FlowAlpPay;
use FlowAlpPay\Models\Request\Paylink;

$client = new FlowAlpPay(
    getenv('FLOWALP_PAY_INSTANCE'),
    getenv('FLOWALP_PAY_API_SECRET'),
    FlowAlpPay::DEFAULT_COMMUNICATION_HANDLER,
    'pay.flowalp.com',
    '1.16'
);

$paylink = new Paylink();
$paylink->setId(57);

$client->delete($paylink);

Response#

Ein erfolgreicher Aufruf liefert HTTP 200 mit dem Erfolgs-Envelope, das den gelöschten Paylink bestätigt.

{
  "status": "success",
  "data": [
    {
      "id": 57
    }
  ]
}

Fehler#

Fehler-Responses verwenden den Envelope {"status": "error", "message": "..."} — siehe Fehler und Rate limits.