Aller au contenu
StampyWalletDocs
API et webhooks / Référence / Annuler un passage

Annuler un passage

DELETE /v1/passages/:id retire le dernier passage d'un client, par exemple après un ticket annulé ou remboursé en caisse.

DELETE/v1/passages/:id

Retire un passage, avec les droits d'un responsable : les tampons ou points qu'il a posés sont enlevés, et une récompense qu'il avait débloquée disparaît avec lui. :id est l'UUID rendu par POST /v1/passages.

Corps facultatif : { "motif": "Ticket annulé" } (ou ?motif= dans l'adresse). Par défaut, le motif est « API ».

Exemple

curl
curl -X DELETE https://app.stampywallet.com/v1/passages/226fdea1-ba59-49fb-93e6-60a14a765134 \
  -H "Authorization: Bearer sw_live_votre_cle" \
  -H "Content-Type: application/json" \
  -d '{"motif": "Ticket remboursé"}'

Réponse

200 OK
{
  "annule": true,
  "recompenses_retirees": 1,
  "client": { "id": "c2a91f3e-7d40-4b8a-a3c5-91e0d6f4b2c7", "prenom": "Léa", "etat": { "tampons": 9, "objectif": 10 } }
}

Les refus

Comme au comptoir, seul le dernier passage d'un client s'annule, et jamais deux fois.

StatutcodeQuand
404passage_introuvableLe passage n'existe pas dans ce commerce
409pas_dernierCe n'est pas le dernier passage du client
409deja_annuleLe passage est déjà annulé
409recompense_offerteLa récompense débloquée par ce passage a déjà été offerte (la réponse porte un champ recompense)

Mis à jour le

Cette page vous a aidé ?