Inviter un client
https://staging.mobupay.nc/api/v1/agency/clients/invitationsCe que fait cet appel
Invite un client à ouvrir son compte sous votre agence, et rend le lien à lui transmettre.
`deliveryMode` choisit qui envoie l'invitation : email (Mobupay envoie le courriel, avec le bouton d'activation du compte), redirect (vous transmettez le lien url vous-même, valeur par défaut) ou both.
`prefill` prépare le dossier : dénomination, enseigne, RIDET, IBAN et BIC. L'IBAN est contrôlé à l'entrée (clé de contrôle) ; il reste vérifié au nom de l'entreprise à l'instruction.
`prefill.registrationNumber` (Nouvelle-Calédonie) : le RIDET de l'établissement (10 chiffres) ou de l'entreprise (7 chiffres). Mobupay le cherche dans l'annuaire de l'ISEE à l'appel et rend ce qu'il a trouvé dans registry : found (l'établissement est identifié, votre client le trouve présélectionné à l'étape d'identité, et le valider remplit l'identité et récupère l'avis RIDET), not_listed (absent de l'annuaire public, le cas des entrepreneurs individuels : l'étape d'identité le recherche auprès de l'ISEE) ou unavailable (annuaire injoignable à l'appel, même suite). Refusé : 422 ESTABLISHMENT_AMBIGUOUS quand un RID à 7 chiffres compte plusieurs établissements (précisez les 10 chiffres), 409 ESTABLISHMENT_ALREADY_LINKED quand l'établissement fait déjà l'objet d'un dossier ou d'un compte Mobupay.
Idempotence. Une externalRef déjà portée par une invitation en cours rend 409 DUPLICATE_INVITATION avec existingId. Une adresse déjà invitée et en cours rend l'invitation existante (200), sans en créer une seconde ni renvoyer le courriel.
En test (clé sk_agy_test_*), l'invitation est simulée : aucun courriel ne part (emailSuppressed: true), aucun dossier ni compte n'est créé, et url mène à une page de bac à sable qui fait avancer l'enrôlement. Plafond : cinquante simulations actives.
S'appelle avec une clé d'agence (sk_agy_test_* ou sk_agy_live_*). Une clé marchande, ou une clé d'intégrateur, reçoit 403 AGENCY_KEY_REQUIRED. Votre propre compte doit être ouvert : sinon 409 AGENCY_ACCOUNT_NOT_OPEN.
Authorization: Bearer sk_test_XXXXLe 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.
Corps de la requête
application/jsonemailstring · emailRequisAdresse du futur client.
deliveryModestringOptionnelQui envoie l'invitation. `redirect` par défaut : rien ne part, vous transmettez `url`.
redirectUrlstring · uriOptionnelAdresse de votre application. Un client dont le compte est ouvert et qui rouvre son lien y est renvoyé.
defaultNamestringOptionnelNom d'affichage préparé, pour vos listes. Facultatif.
Prénom, nom et téléphone du destinataire.
Ce qui est prérempli dans le dossier.
externalRefstringOptionnelVotre référence. Renvoyée dans les événements, filtrable en liste.
metadataobjectOptionnelDonnées libres (4 000 caractères au plus), renvoyées dans les événements.
expiresInHoursintegerOptionnelDurée de validité du lien. Quatorze jours par défaut.
languagestringOptionnelrequestedScopearray[string]OptionnelLes capacités que vous demandez au client de vous accorder (`view_kpis`, `manage_payments`, `dev_access`...). Le client coche ce qu'il accorde.
Codes de retour
Invitation créée.
Corps invalide, dont un IBAN prérempli dont la clé de contrôle est fausse, ou un RIDET qui n'a ni 7 ni 10 chiffres.
AGENCY_KEY_REQUIRED : la clé présentée n'est pas une clé d'agence.
DUPLICATE_INVITATION (avec existingId), ESTABLISHMENT_ALREADY_LINKED ou AGENCY_ACCOUNT_NOT_OPEN.
ESTABLISHMENT_AMBIGUOUS : le RID à 7 chiffres compte plusieurs établissements ; envoyez le RIDET à 10 chiffres.
SIMULATION_QUOTA_EXCEEDED : cinquante simulations actives, en test seulement.
Langage
Cliquez sur Essayer pour lancer la requête et voir la réponse ici. Ou choisissez un exemple :
application/json