MobupayMobupay
Chargement de vos clés API…

Annuler un paiement en attente

POSThttps://api.mobupay.nc/api/v1/payments/{id}/cancel

Ce que fait cet appel

Annule un paiement qui n'a pas encore abouti (statut pending) : la session de paiement est close, le porteur ne peut plus payer, et le webhook payment.cancelled est émis avec cancelledBy: "merchant_api".

Cas d'usage : votre client a quitté le paiement sans le terminer (par exemple pendant l'authentification 3-D Secure, dans une vue web d'application) et ouvre une nouvelle commande. Annulez la précédente plutôt que d'attendre son expiration.

Idempotent : annuler un paiement déjà annulé rend 200 avec la même réponse. L'en-tête Idempotency-Key est accepté.

Un paiement déjà autorisé ne s'annule pas ici (409 PAYMENT_NOT_CANCELLABLE, avec son statut courant) : libérez une autorisation par le remboursement (POST /api/v1/payments/{id}/refund).

Authentification bancaire en cours : l'annulation ne retire pas l'écran de la banque, qui ne peut pas être fermé à distance. Si le porteur valide malgré tout, l'autorisation obtenue est rendue automatiquement par Mobupay : le paiement reste annulé et aucun débit n'est conservé.

En-tête d'authentification
Authorization: Bearer sk_test_XXXX

Le pool est déduit du préfixe de la clé

Il n'y a pas d'interrupteur test et production sur cette page. sk_test_* ne traite aucun paiement réel, sk_live_* encaisse.

Paramètres

2 en-têtes
idstringRequispath

Identifiant du paiement (`pay_*`) en statut `pending`.

Idempotency-KeystringOptionnelheader

Clé d'idempotence facultative. L'appel étant idempotent par nature, un rejeu rend la même réponse.

Codes de retour

200

Paiement annulé (ou déjà annulé).

404

Paiement introuvable pour ce marchand et cet environnement.

409

Le paiement n'est plus en attente (PAYMENT_NOT_CANCELLABLE). details.currentStatus porte son statut : authorized, transit, captured, failed ou expired.

Langage

Requête cURLpostExemple
1curl --request POST \
2 --url https://api.mobupay.nc/api/v1/payments/{id}/cancel \
3 --header 'authorization: Bearer sk_test_XXXX'
Réponse

Cliquez sur Essayer pour lancer la requête et voir la réponse ici. Ou choisissez un exemple :

application/json