DELETEDemandes de paiement

Annuler une demande

Annule une demande de paiement encore en attente. Possible uniquement si le statut est pending ou notified — au-delà (déjà payée, refusée ou expirée), l'annulation est refusée.

URL

DELETEhttps://developer.caurispay.net/v1/developer/payment-requests/:token

Headers

X-Api-KeyrequisVotre clé publique
X-Api-SecretrequisVotre clé secrète

Paramètre d'URL

tokenstringrequisIdentifiant de la demande à annuler

À savoir

L'annulation retire aussi la tâche d'expiration programmée pour cette demande, et déclenche immédiatement le webhook payment_request.cancelled.

Réponse — 200 OK

successbooleantrue si l'annulation a réussi
messagestringMessage lisible décrivant le résultat
statusstringNouveau statut de la demande : cancelled
tokenstringIdentifiant de la demande annulée
expiresAtstring (ISO 8601)Date d'expiration d'origine, conservée à titre indicatif

Codes d'erreur

401API_KEY_MISSING

Aucune clé API fournie dans les headers

401INVALID_API_KEY

Clé API invalide ou révoquée

404PAYMENT_REQUEST_NOT_FOUND

Aucune demande trouvée pour ce token, ou elle n'appartient pas à ce compte

409CANNOT_CANCEL_IN_CURRENT_STATE

La demande est déjà payée, refusée, annulée ou expirée