MobupayMobupay
Chargement de vos clés API…

Récupérer un paiement

GEThttps://staging.mobupay.nc/api/v1/payments/{id}

Ce que fait cet appel

Récupère les détails complets d'un paiement par son identifiant. Inclut le statut courant (created, authorized, captured, refunded, partially_refunded, failed, canceled), la boutique d'encaissement (store, sous la forme { id, code, name }, null si le paiement n'en porte aucune), la commande (order), les commissions (orderPaymentFees), les mouvements de compte associés, l'éventuel platformConfig stocké à la création, fundingMode (card ou platform_funded), ainsi que settlement (commission Mobupay + net) et, pour les paiements platform, platformDistribution (redistribution par sous-marchand), en devise d'origine. settlement.settled indique la nature de ce détail : true lorsqu'il décrit les mouvements de compte réellement effectués, false lorsqu'il s'agit de la répartition prévisionnelle (le règlement de l'acquéreur n'est pas encore parvenu, environ 24h après la capture). Une répartition prévisionnelle peut donc différer du versement final, notamment en cas de capture partielle. Note : un paiement est instantané côté marchand : une capture partielle est présentée comme captured (le détail de compensation reste interne).

Factures et remboursements : invoices liste les factures Mobupay nées de ce paiement et leurs avoirs ({ id, number, kind, status, creditsInvoiceId }, kind valant invoice ou credit_note), vide si aucune facture n'a été demandée. refundedAmount est le cumul déjà remboursé et refundableAmount ce qui peut encore l'être, dans la devise d'origine : c'est le montant que POST /api/v1/payments/{id}/refund acceptera.

Authentification 3-D Secure en cours : authentication.challengeInProgress vaut true quand le porteur est en train de répondre au défi de sa banque, avec l'heure d'ouverture du défi dans authentication.challengeOpenedAt. Un paiement pending dans cet état peut encore aboutir, souvent dans les secondes qui suivent : ne le considérez pas comme abandonné. Un défi reste ouvert au plus 6 minutes. Un refus d'authentification conclut le paiement en failed, avec failureCode: "authentication_refused", 5 minutes après le refus si le porteur n'a pas essayé une autre carte entre-temps.

Protection contre la fraude : authentication.result dit ce que la banque a répondu, lu sur la transaction : authentifie (le porteur a été authentifié), tente (authentification présentée sans transfert de responsabilité), exempte (Mobupay a demandé l'exemption et la banque l'a accordée) ou sans_authentification. authentication.liabilityShift vaut true quand la charge d'une contestation pour fraude revient à la banque émettrice. authentication.exempted vaut true pour un paiement exempté, qui n'est donc pas protégé contre la fraude. Ces trois champs valent null tant que la réponse n'est pas connue (quelques secondes après l'autorisation) et pour les paiements antérieurs à octobre 2026.

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_*`).

Codes de retour

200

Paiement trouvé.

404

Paiement introuvable.

Langage

Requête cURLgetExemple
1curl --request GET \
2 --url https://api.mobupay.nc/api/v1/payments/{id} \
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