Récupérer et lister les Paylinks

Lisez un Paylink à partir de son ID pour inspecter sa configuration ou pour vérifier qu'une notification de paiement lui appartient réellement. Dans la Merchant API, la ressource Paylink s'appelle Invoice.

Utilisez la version d'API v1.16 pour toute nouvelle intégration ; v1.14 et v1.15 restent prises en charge. Authentifiez-vous avec l'en-tête X-API-KEY — voir Authentification.

Requête#

Paramètres de chemin#

Paramètres de requête (query)#

Exemple de requête#

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();

Réponse#

Le Paylink est renvoyé dans l'enveloppe de succès. Schéma courant : lorsqu'un webhook annonce un paiement, appelez cet endpoint avec l'ID enregistré et comparez referenceId et amount avec vos propres données avant de marquer la facture comme payée.

{
  "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"
    }
  ]
}

Lister les Paylinks#

Les versions d'API v1.14 à v1.16 ne documentent pas de requête de collection renvoyant tous les Paylinks d'une instance, et aucun paramètre de pagination n'est disponible pour cette ressource. Récupérez les Paylinks individuellement par ID et enregistrez la correspondance entre id, hash et referenceId dans votre propre base de données dès la création.

Erreurs#

Les réponses d'erreur utilisent l'enveloppe {"status": "error", "message": "..."} — voir Erreurs et Limites de débit.