MobupayMobupay
Chargement de vos clés API…

Émettre une facture

POSThttps://api.mobupay.nc/api/v1/billing/invoices/{id}/issue

Ce que fait cet appel

Émet un brouillon : lui alloue son numéro définitif, fige son contenu et archive son PDF pour dix ans.

Irréversible. Le numéro est alloué de façon atomique dans une séquence continue et n'est jamais réutilisé, même si l'archivage du PDF échoue ensuite.

L'appel est refusé en 422 si une mention obligatoire manque, avec la liste et le fondement légal de chacune.

Avoir sur une facture réglée. L'argent que l'avoir libère a deux sorts possibles, que vous choisissez par refund :

- refund absent ou `false` : le montant réglé est conservé au crédit du client. Un trop-perçu naît, imputable sur une autre facture du même client par POST /api/v1/billing/overpayments/{id}/apply. C'est le comportement par défaut. - refund: true, facture réglée hors Mobupay (virement, espèces, chèque) : le remboursement que vous avez fait est constaté. refundMethod, refundedAt et refundReference sont alors obligatoires (400 CREDIT_NOTE_REFUND_PROOF_REQUIRED sinon). Aucun crédit n'est conservé. - refund: true, facture réglée par un paiement Mobupay : refus 409 CREDIT_NOTE_CARD_REFUND_REQUIRED. Remboursez le paiement (POST /api/v1/payments/{id}/refund) : son remboursement émet lui-même l'avoir. Si la facture a aussi été réglée hors Mobupay, émettez ensuite un avoir pour le reste, avec le constat.

La réponse porte alors disposition : le sort appliqué (credit, offline_refund, nothing_to_return), le montant et l'identifiant du trop-perçu. Ces champs n'ont aucun effet sur une facture ordinaire ni sur un avoir d'une facture non réglée.

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 de la facture (`ivc_*`).

Corps de la requête

application/json
refundbooleanOptionnel

Avoir d'une facture réglée seulement : `true` si le client est remboursé. **Absent = `false`** : le montant réglé est conservé au crédit du client.

refundMethodstringOptionnel

Remboursement hors Mobupay : le moyen employé.

refundedAtstring · dateOptionnel

Remboursement hors Mobupay : la date, en `AAAA-MM-JJ`.

refundReferencestringOptionnel

Remboursement hors Mobupay : la référence (numéro de virement, de chèque…), 200 caractères au plus.

Codes de retour

200

Facture émise.

400

CREDIT_NOTE_REFUND_PROOF_REQUIRED : remboursement hors Mobupay sans son constat.

409

INVOICE_ALREADY_ISSUED : cette facture porte déjà un numéro. CREDIT_NOTE_CARD_REFUND_REQUIRED : la part réglée par un paiement Mobupay se rembourse par ce paiement.

422

INVOICE_INCOMPLETE : mentions obligatoires manquantes.

Langage

Requête cURLpostExemple
1curl --request POST \
2 --url https://api.mobupay.nc/api/v1/billing/invoices/{id}/issue \
3 --header 'authorization: Bearer sk_test_XXXX' \
4 --header 'content-type: application/json' \
5 --data '{ "refund": "<boolean>", "refundMethod": "<string>", "refundedAt": "<string>", "refundReference": "<string>" }'
Réponse

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

application/json