MobupayMobupay
Chargement de vos clés API…

Lister les sous-marchands

GEThttps://api.mobupay.nc/api/v1/platform/merchants

Ce que fait cet appel

Réservé aux comptes Platform. Liste les marchands rattachés à votre plateforme, avec leur état d'enrôlement.

Le rattachement n'est posé qu'à l'ouverture effective du compte : un marchand présent dans cette liste est un marchand pour lequel vous pouvez encaisser. Les partenaires dont le dossier est encore en cours se suivent par GET /platform/onboarding-sessions.

Seul un sous-ensemble public est exposé : nom légal, numéros d'enregistrement, pays, dates et état. Jamais d'IBAN, de pièce ni de personne.

Deux numéros, deux niveaux. registrationNumber est celui de la société : tous les établissements d'une même société le partagent. establishmentNumber est celui de l'établissement, et c'est lui qui identifie un lieu : deux boutiques d'une même société s'y distinguent. Pour rapprocher un sous-marchand de votre propre référentiel, employez establishmentNumber.

Les deux sont des chaînes de caractères, zéros de tête compris : ne les convertissez pas en nombre, un RIDET calédonien peut commencer par un zéro. La longueur dépend du territoire, lisible dans country : Nouvelle-Calédonie 10 chiffres (7 pour la société), Polynésie française 9 (6), France et Wallis-et-Futuna 14 (9). null tant que le dossier ne le porte pas.

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

2 en-têtes
includeUnlinkedbooleanOptionnelquery

Inclure les rattachements révoqués. Faux par défaut.

limitintegerOptionnelquery

Nombre maximum de résultats (1 à 200, défaut 100).

Codes de retour

200

Liste des sous-marchands.

403

PERMISSION_ERROR, message commençant par PLATFORM_REQUIRED : contrat Platform requis.

Langage

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