Modifier et supprimer un Paylink

Cette page explique comment modifier et comment retirer un Paylink existant. La suppression est un simple appel API ; la modification des paramètres se fait en revanche par remplacement, car la Merchant API n'offre pas de mise à jour en place pour cette ressource.

Modifier un Paylink#

Les versions d'API v1.14 à v1.16 ne prévoient pas d'opération PUT pour la ressource Paylink (Invoice) : une fois créé, un Paylink ne peut pas être modifié via l'API. Pour changer le montant, les textes ou la date d'expiration d'un lien pas encore payé :

1. Créez un nouveau Paylink avec les paramètres corrigés — voir Créer un Paylink.
2. Publiez le nouveau lien partout où l'ancien était partagé (e-mail, code QR, document de facture).
3. Supprimez le Paylink obsolète avec l'appel ci-dessous afin que plus personne ne puisse payer dessus.

Supprimer un Paylink#

La suppression retire le Paylink à partir de son ID ; son URL n'accepte plus aucun paiement. Authentifiez-vous avec l'en-tête X-API-KEY — voir Authentification.

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

Réponse#

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

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

Erreurs#

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