MobupayMobupay
Chargement de vos clés API…

Vérifier l'éligibilité à la franchise

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

Ce que fait cet appel

Compare le chiffre d'affaires transmis aux seuils de franchise en base de la juridiction du marchand.

Une activité mixte doit respecter les deux seuils, pas leur somme.

eligible: null signifie que les seuils ne sont pas établis pour la juridiction, ce qui n'est pas la même chose que « non éligible » : ne traitez pas les deux cas de la même façon.

Deux conséquences à connaître avant de conseiller la franchise : un marchand en franchise ne peut porter aucune taxe sur ses factures, toute taxe mentionnée étant due par son émetteur même à tort ; et en Nouvelle-Calédonie l'abandon de la franchise est irrévocable.

Le régime lui-même se déclare par PUT /billing/settings (franchiseEnabled), cet appel ne fait que renseigner.

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

3 en-têtes
activitystringOptionnelquery

`goods`, `services` ou `mixed`. Défaut `mixed`.

goodsCentsintegerOptionnelquery

Chiffre d'affaires sur les biens, dans la plus petite unité de la devise.

servicesCentsintegerOptionnelquery

Chiffre d'affaires sur les services.

Codes de retour

200

Éligibilité calculée.

Langage

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