MobupayMobupay
Chargement de vos clés API…

Lister les factures

GEThttps://api.mobupay.nc/api/v1/billing/invoices

Ce que fait cet appel

Liste les factures émises par le marchand, les plus récentes d'abord. Filtrable par statut.

Statuts possibles : draft (brouillon, sans numéro), issued (numérotée et figée), sent (transmise au destinataire), unpaid (échéance d'abonnement dont le prélèvement a échoué, toujours à régler), partially_paid, paid, overdue (échéance dépassée), disputed (règlement contesté), rectified (annulée par une rectificative), credited (annulée par un avoir), uncollectible (créance irrécouvrable).

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

4 en-têtes
statusstringOptionnelquery

Statuts séparés par des virgules (ex: `sent,overdue`).

limitintegerOptionnelquery

Nombre d'éléments, 1 à 100. Défaut 50.

offsetintegerOptionnelquery

Décalage de pagination.

paymentIdstringOptionnelquery

Paiement (`pay_*`) : les documents qui lui sont rattachés (facture créée avec ce `paymentId`, facture réglée par lui ou rattachée à lui) et les avoirs qui les créditent. C'est la façon de retrouver une facture après une réponse perdue.

Codes de retour

200

Liste des factures. Chaque élément porte notamment id, number, kind, status, paymentId, creditsInvoiceId, issuedAt et paidAt.

401

Clé API manquante ou invalide.

403

Permission billing.read absente. La lecture reste ouverte quand le module est désactivé : vos documents passés restent consultables.

Langage

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