Chargement de vos clés API…

Inviter un client à ouvrir son compte

POSThttps://api.mobupay.nc/api/v1/integrator/clients/invitations

Ce que fait cet appel

Invite un client à ouvrir son compte Mobupay, et rend le lien à lui transmettre. Votre client constitue seul son dossier : vous n'en lisez que l'état.

`deliveryMode` choisit qui envoie l'invitation : redirect (vous transmettez le lien url vous-même, valeur par défaut), email (Mobupay envoie le courriel) ou both.

`prefill` ne porte que l'identité commerciale pressentie : dénomination, enseigne, numéro d'immatriculation. Rien d'autre ne se prépare.

Le consentement. À la soumission de son dossier, votre client coche l'autorisation donnée à votre logiciel d'accéder à son compte. Sans elle, le compte ouvre mais aucune clé n'est générée pour vous (consented: false). Votre client peut vous autoriser plus tard, depuis Paramètres, Logiciels connectés : la clé naît alors et vous est annoncée par integrator.client.key.available.

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_int_test_*), l'invitation est simulée : aucun courriel ne part (emailSuppressed: true), et url mène à une page de bac à sable qui fait avancer l'enrôlement. Plafond : cinquante simulations actives (429 SIMULATION_QUOTA_EXCEEDED).

S'appelle avec une clé d'intégrateur (sk_int_test_* ou sk_int_live_*). Toute autre clé reçoit 403 INTEGRATOR_KEY_REQUIRED.

Portée de clé requise : integrator.invitations.write (403 INTEGRATOR_SCOPE_REQUIRED sinon).

En-tête d'authentification

Authorization: Bearer sk_int_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_int_test_* ne traite aucun paiement réel, sk_int_live_* encaisse.

Corps de la requête

application/json

contactEmailstring · emailRequis

Adresse de votre client.

deliveryModestringOptionnel

Qui envoie l'invitation. `redirect` par défaut : rien ne part, vous transmettez `url`.

redirectUrlstring · uriOptionnel

Adresse de votre application (HTTPS, ou `http://localhost` en développement). Votre client y revient après la soumission, avec `invitation_id`, `external_ref` et `status` ajoutés à l'adresse.

externalRefstringOptionnel

Votre référence. Renvoyée dans les événements, filtrable en liste.

metadataobjectOptionnel

Données libres (4 000 caractères au plus), renvoyées avec l'invitation.

objectOptionnel

L'identité commerciale pressentie, et rien d'autre.

expiresInHoursintegerOptionnel

Durée de validité du lien. Quatorze jours par défaut.

languagestringOptionnel

Codes de retour

200

Une invitation en cours existait déjà pour cette adresse : elle est rendue telle quelle.

201

Invitation créée.

403

INTEGRATOR_KEY_REQUIRED : la clé présentée n'est pas une clé d'intégrateur.

409

DUPLICATE_INVITATION, avec existingId.

429

SIMULATION_QUOTA_EXCEEDED : cinquante simulations actives, en test seulement.

Langage

Requête cURLpostExemple

1curl --request POST \

2 --url https://api.mobupay.nc/api/v1/integrator/clients/invitations \

3 --header 'authorization: Bearer sk_int_test_XXXX' \

4 --header 'content-type: application/json' \

5 --data '{ "contactEmail": "gerant@lebonplat.nc", "deliveryMode": "redirect", "redirectUrl": "https://app.votre-logiciel.nc/mobupay/retour", "externalRef": "etab_00412", "prefill": { "brandName": "Le Bon Plat" } }'

Réponse

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

application/json