MobupayMobupay
Chargement de vos clés API…

Consulter vos commissions d'intégrateur

GEThttps://api.mobupay.nc/api/v1/integrator/commissions

Ce que fait cet appel

Vos commissions, paiement par paiement, la plus récente d'abord. Chaque ligne porte la commission seule, jamais le montant de la vente de votre client : sa référence (reference, MBP-…) et celle du paiement d'origine (paymentReference, avec paymentId), le dû taxes comprises (commissionAmount), sa taxe (taxAmount) et son hors taxe (amountExclTax), la règle figée à la création du paiement (rule : type, value, overInclTax, taxDetail), le prélevé (collectedAmount), le reste de ce paiement (shortfallAmount), figé à son prélèvement, et la commission suivante de ce client qui l'a repris (reliquatRepris : id, reference, at, date de son prélèvement ; null tant que rien ne l'a repris), le reste antérieur repris sur lui (carriedShortfallAmount), la règle appliquée (commissionSource : P1_REQUEST pour la commission de la requête, P2_LINK pour celle convenue pour ce client, P3_INTEGRATOR_DEFAULT pour celle de votre espace, P4_NONE), l'état du paiement (paymentStatus) : une ligne naît avec la session de paiement, et un paiement expiré ou annulé ne sera jamais prélevé ; et ce qui a été rendu à votre client sur ses remboursements (restitutedAmount) : un remboursement ne vous reprend que la part de votre commission que VOUS avez choisi de rendre, en remboursant avec la clé que vous détenez (rien à défaut : un remboursement fait par votre client est à ses frais), et chaque restitution vous est annoncée par integrator.commission.restituted. Ce qui vous arrivera au prochain encaissement (upcomingAmount) n'est pas toujours le dû : une plateforme ne vous verse jamais plus qu'elle n'a reçu sur ce paiement, et l'écart part en reste dû. Chaque ligne porte son état (etat) : paiement_en_cours, a_venir, percue, partielle (prélevée en partie), reportee (rien n'a pu être prélevé, tout est reporté), rendue, rendue_en_partie, sans_objet (paiement abandonné). Montants en centimes d'euro.

Filtres : merchantId, from et to (dates ISO ; depuis le début du mois civil par défaut), limit (1 à 200, 50 par défaut).

Portée de clé requise : integrator.commissions.read (403 INTEGRATOR_SCOPE_REQUIRED sinon).

En-tête d'authentification
Authorization: Bearer sk_int_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_int_test_* ne traite aucun paiement réel, sk_int_live_* encaisse.

Paramètres

4 en-têtes
merchantIdstringOptionnelquery
fromstring , date-timeOptionnelquery
tostring , date-timeOptionnelquery
limitintegerOptionnelquery

Codes de retour

200

Vos commissions.

Langage

Requête cURLgetExemple
1curl --request GET \
2 --url https://api.mobupay.nc/api/v1/integrator/commissions \
3 --header 'authorization: Bearer sk_int_test_XXXX'
Réponse

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

application/json