Chargement de vos clés API…

Libérer le reliquat d'une autorisation

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

Ce que fait cet appel

Rend au client la part de l'autorisation qui n'a pas été capturée, après une capture partielle. Sans cet appel, ce reliquat reste réservé sur la carte jusqu'à l'expiration de l'autorisation (moins de 7 jours).

La capture reste acquise. Aucun fonds n'est débité ni remboursé, et aucune répartition (platformConfig) n'est demandée : rendre une réservation ne déplace aucun argent. Le paiement reste remboursable dans la limite de ce qui a été capturé, et ne peut plus être capturé à nouveau.

Pour le faire au moment de la capture, passez closeAuthorization: true à POST /api/v1/payments/{id}/capture. Pour annuler une autorisation qui n'a jamais été capturée, utilisez POST /api/v1/payments/{id}/refund.

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_*`), capturé en mode `MANUAL`.

Codes de retour

200

Reliquat libéré, ou rien à libérer (released: false). releasedAmount est en centimes d'euro, la devise de l'autorisation carte. Une seconde demande rend alreadyReleased: true sans nouvel appel à l'acquéreur.

404

Paiement introuvable pour ce marchand et cet environnement.

409

Le paiement n'a pas été capturé (INVALID_PAYMENT_STATUS, details.currentStatus), ou n'est pas en capture manuelle (REMAINDER_RELEASE_UNSUPPORTED). Après un remboursement, l'acquéreur ne libère plus le reliquat (REMAINDER_NOT_RELEASABLE_AFTER_REFUND) : il le sera à l'expiration de l'autorisation ; libérez-le donc avant de rembourser. Si la capture n'est pas encore visible chez l'acquéreur, rien n'est libéré (REMAINDER_RELEASE_PENDING, details.retryable: true) : rejouez l'appel quelques secondes plus tard.

502

L'acquéreur n'a pas pu libérer le reliquat (REMAINDER_RELEASE_FAILED). details.retryable indique si l'appel peut être rejoué.

Langage

Requête cURLpostExemple

1curl --request POST \

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

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