Paylinks abrufen und auflisten

Lesen Sie einen einzelnen Paylink anhand seiner ID, um seine Konfiguration einzusehen oder zu prüfen, ob eine Zahlungsbenachrichtigung wirklich zu ihm gehört. In der Merchant API heisst die Paylink-Ressource Invoice.

Verwenden Sie für neue Integrationen die API-Version v1.16; v1.14 und v1.15 werden weiterhin unterstützt. Authentifizieren Sie sich mit dem Header X-API-KEY — siehe Authentifizierung.

Request#

Path-Parameter#

Query-Parameter#

Beispiel-Request#

curl --request GET \
  --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);

$response = $client->getOne($paylink);

$link        = $response->getLink();
$referenceId = $response->getReferenceId();

Response#

Der Paylink wird im Erfolgs-Envelope zurückgegeben. Ein bewährtes Muster: Wenn ein Webhook eine Zahlung meldet, rufen Sie diesen Endpoint mit der gespeicherten ID auf und vergleichen referenceId und amount mit Ihren eigenen Daten, bevor Sie die Rechnung als bezahlt markieren.

{
  "status": "success",
  "data": [
    {
      "id": 57,
      "hash": "f7d1b2e94c3a48d2a5efb6c17d0a9c31",
      "referenceId": "INV-2026-0042",
      "link": "https://demo-shop.pay.flowalp.com/?payment=f7d1b2e94c3a48d2a5efb6c17d0a9c31",
      "title": "Invoice INV-2026-0042",
      "description": "Consulting services, June 2026",
      "purpose": "Invoice INV-2026-0042",
      "amount": 8925,
      "currency": "CHF",
      "createdAt": "2026-07-30 11:52:08"
    }
  ]
}

Paylinks auflisten#

Die API-Versionen v1.14 bis v1.16 dokumentieren keine Sammelabfrage, die alle Paylinks einer Instance zurückgibt; für diese Ressource stehen auch keine Paginierungsparameter zur Verfügung. Rufen Sie Paylinks einzeln per ID ab und speichern Sie die Zuordnung von id, hash und referenceId bereits bei der Erstellung in Ihrer eigenen Datenbank.

Fehler#

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