FlowAlp

Récupérer un Gateway

July 30, 2026

Récupérez un Gateway FlowAlp Pay par ID et vérifiez le statut du paiement (waiting, confirmed, authorized, reserved). Exemples curl et PHP.

Récupérer un Gateway lit l'état actuel d'un Gateway à partir de son ID. Utilisez-le pour vérifier si un checkout a été payé — par exemple pour contre-vérifier un webhook reçu — ou pour retrouver le lien de paiement et la configuration.

GEThttps://api.pay.flowalp.com/v1.16/Gateway/{id}/v1.14 · v1.15 · v1.16

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ètreTypeObligatoireDescription
idintegerOuiID du Gateway à récupérer, tel que renvoyé lors de sa création.

Paramètres de requête (query)

ParamètreTypeObligatoireDescription
instancestringOuiNom de votre instance marchande ; identifie votre compte à chaque appel API.

Exemple de requête

Récupérer un Gateway (cURL)bash
curl --request GET \
  --url "https://api.pay.flowalp.com/v1.16/Gateway/42/?instance=${FLOWALP_PAY_INSTANCE}" \
  --header "X-API-KEY: ${FLOWALP_PAY_API_SECRET}"
Récupérer un Gateway (SDK PHP)PHP
<?php
use FlowAlpPay\FlowAlpPay;
use FlowAlpPay\Models\Request\Gateway;

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

$gateway = new Gateway();
$gateway->setId(42);

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

// waiting, confirmed, authorized or reserved
$status = $response->getStatus();

Réponse

Le Gateway est renvoyé dans l'enveloppe de succès standard. Le champ status indique où en est le paiement.

200 OKJSON
{
  "status": "success",
  "data": [
    {
      "id": 42,
      "status": "confirmed",
      "hash": "cb1a4e6ad0714b8c93cbfe6a6e2489d5",
      "referenceId": "ORDER-2026-001",
      "link": "https://demo-shop.pay.flowalp.com/?payment=cb1a4e6ad0714b8c93cbfe6a6e2489d5",
      "amount": 8925,
      "currency": "CHF",
      "preAuthorization": false,
      "reservation": false,
      "createdAt": "2026-07-30 11:52:08"
    }
  ]
}

Valeurs du statut de paiement

ValeurSignificationÉtape suivante typique
waitingAucun paiement finalisé ; le client n'a pas (encore) terminé le checkout avec succès.Patientez ou laissez le Gateway expirer ; la confirmation arrive par webhook.
confirmedLe paiement est finalisé et le montant a été débité.Traitez la commande et rapprochez-la via referenceId.
authorizedLe moyen de paiement a été autorisé ou enregistré, mais aucun montant n'a encore été débité.Débitez plus tard le moyen enregistré via l'API Transactions.
reservedLe montant est réservé sur le moyen de paiement du client.Capturez la réservation pour encaisser le montant.

Préférez les webhooks au polling de cet endpoint : FlowAlp Pay notifie votre serveur dès que l'état du paiement change ; vous pouvez alors appeler Récupérer un Gateway pour vérifier la notification auprès de l'API avant de mettre à jour la commande. Pour débiter ou capturer les paiements authorized et reserved, utilisez l'API Transactions.

Erreurs

Statut HTTPSignificationAction recommandée
404Aucun Gateway avec cet ID n'existe sur votre instance.Vérifiez l'ID de Gateway enregistré et le paramètre instance.

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

Sur le même sujet : créez des checkouts avec Créer un Gateway, supprimez les Gateways inutilisés avec Supprimer un Gateway et configurez les notifications dans Configurer les webhooks.