Supprimer un Gateway

Supprimer un Gateway retire un Gateway à partir de son ID, de sorte que son lien de checkout ne peut plus être utilisé. Cas d'usage typique : nettoyer les Gateways créés mais jamais payés, par exemple après l'abandon d'une commande par un client.

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 DELETE \
  --url "https://api.pay.flowalp.com/v1.16/Gateway/42/?instance=${FLOWALP_PAY_INSTANCE}" \
  --header "X-API-KEY: ${FLOWALP_PAY_API_SECRET}"

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

$client->delete($gateway);

Réponse#

Un appel réussi renvoie HTTP 200 avec l'enveloppe de succès confirmant le Gateway supprimé.

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

Erreurs#

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