Chargement de vos clés API…

Rembourser ou annuler un paiement

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

Ce que fait cet appel

Rembourse tout ou partie d'un paiement capturé (crédit réel vers la carte), ou annule (void) une autorisation non encore capturée (aucun débit n'a eu lieu). L'opération est déterminée automatiquement par l'état du paiement. amountCents est optionnel, exprimé dans la devise d'origine du paiement : absent = remboursement/annulation total ; les remboursements partiels et multiples sont supportés tant que la somme n'excède pas le montant initial. Mobupay émet le webhook correspondant (payment.refunded, payment.partially_refunded ou payment.cancelled). Pour les modes de financement plateforme (marchand absorbe / plateforme absorbe / split) et le cas net carte = 0, voir la section Cas d'usage (/docs/usecases/distant/plateforme/cas-particuliers).

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

1 en-tête

idstringRequispath

Identifiant du paiement (`pay_*`) en statut `authorized` ou `captured`.

Corps de la requête

application/json

Type de commande

amountCentsintegerOptionnel

Montant à rembourser dans la devise d'origine du paiement (XPF francs ou EUR cents, comme `order.currency`). **Optionnel** : absent ⇒ remboursement/annulation total. Ne peut pas excéder le montant initial du paiement.

reasonstringOptionnel

Motif libre du remboursement (max 500 caractères). Conservé dans `audit_log`.

objectOptionnel

Configuration platform pour le remboursement. Requise pour les paiements de type `platform` afin de définir qui finance le remboursement.

Codes de retour

200

Remboursement ou annulation effectué.

400

Montant invalide, statut paiement incompatible, incohérence segmentation/items, ou remboursement partiel d'un paiement à net 0 (PARTIAL_REFUND_UNSUPPORTED_NET0).

404

Paiement introuvable.

Langage

Requête cURLpostExemple

1curl --request POST \

2 --url https://api.mobupay.nc/api/v1/payments/{id}/refund \

3 --header 'authorization: Bearer sk_test_XXXX' \

4 --header 'content-type: application/json' \

5 --data '{ "amountCents": 1000, "reason": "Demande client", "items": [ { "product": "Coca-Cola 33cl", "unitPrice": 500, "quantity": 2 } ] }'

Réponse

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

application/json