Agence
Activer le module
Deux familles de clés. Une clé sk_agy_* pilote votre agence : inviter, ouvrir et suivre les dossiers de vos clients, recevoir leurs événements. Elle s'émet depuis les réglages de votre espace agence, une fois votre propre compte ouvert. Une clé sk_user_* lit en lecture seule les marchands qui vous ont accordé un accès.
1D'abord, obtenir votre espace agence
Le mode agence ne s'active pas seul : il se demande à l'ouverture de votre compte, puis Mobupay valide votre agence. Si vous ouvrez votre compte, cochez Devenir agence partenaire dès la première étape de l'inscription : la case paraît, sous « Et aussi », quand vous choisissez d'encaisser des paiements. Si votre compte est déjà ouvert, demandez-le à Mobupay. Une fois votre agence validée, la carte « Espace agence » apparaît sur votre accueil.
Demander l'espace agence2Ensuite, une fois votre agence validée, créez votre clé d'agence.
Espace agence, Paramètres, section « Clés de délégation », puis « Émettre une clé ». Réservé au titulaire de l'agence et aux collaborateurs ayant le rôle Administrateur. La vue agrégée en lecture seule demande, elle, une clé sk_user_* (Profil, Réglages). S'ouvre dans un nouvel onglet.
Ce que le compte doit porter
- 1Une agence active, dont le compte est ouvert.
- 2Une clé
sk_agy_test_*pour recetter en simulation,sk_agy_live_*pour le réel. - 3Pour la vue agrégée : une clé
sk_user_test_*ousk_user_live_*, et au moins un accès marchand accordé.
Si la condition n'est pas remplie
Une clé qui n'est pas une clé d'agence répond 403 AGENCY_KEY_REQUIRED sur les endpoints agency/*. Une agence dont le compte n'est pas ouvert reçoit 409 AGENCY_ACCOUNT_NOT_OPEN à l'invitation. Sur la vue agrégée, une clé marchande répond 403 USER_KEY_REQUIRED.
Par où entrer
/api/v1/agency/clients/invitationsGETSuivre vos invitations/api/v1/agency/clients/invitationsGETLister les marchands accessibles/api/v1/user/merchantsGuides de recettes
Une clé `sk_agy_*` invite vos clients, ouvre leur dossier, et suit son instruction. Voici l'ordre des appels, et comment le recetter en simulation.
Une clé `sk_user_*` lit plusieurs marchands à la fois, en lecture seule. Voici l'ordre des appels.
Rapprocher les virements de leurs paiements, sur plusieurs comptes, sans demander l'accès aux relevés.