Chargement de vos clés API…

Inviter un marchand

POSThttps://api.mobupay.nc/api/v1/platform/onboarding-sessions

Ce que fait cet appel

Réservé aux comptes Platform. Crée une session d'onboarding sous votre plateforme et invite un marchand à créer ou connecter son compte Mobupay pour s'y affilier. Selon deliveryMode, Mobupay envoie un email d'invitation au contact (email), renvoie un lien magique à diffuser vous-même (redirect), ou les deux (both). L'affiliation (lien plateforme ↔ marchand) n'est matérialisée qu'une fois le dossier KYB du marchand soumis. Aucune donnée sensible n'est exposée. Cet endpoint n'a pas de mode simulation : appelé avec une clé de test, il crée une invitation réelle et envoie un véritable email au contact, car l'enrôlement qui suit est un vrai dossier KYB. L'environnement de la clé détermine seulement les points de terminaison webhook notifiés.

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.

Corps de la requête

application/json

deliveryModestringRequis

`email` : Mobupay envoie l'invitation au contact. `redirect` : la réponse contient le lien magique à diffuser vous-même. `both` : email + lien.

redirectUrlstringOptionnel

URL de retour vers votre plateforme après finalisation (requise si `deliveryMode` vaut `redirect` ou `both`).

objectRequis

Coordonnées du marchand invité.

objectOptionnel

Informations pré-remplies pour accélérer le KYB du marchand (optionnel).

objectOptionnel

Contexte propre à votre plateforme (optionnel).

expiresInHoursintegerOptionnel

Durée de validité du lien en heures. Défaut 168 (7 jours), max 720 (30 jours).

languagestringOptionnel

Langue de l'email d'invitation. Défaut `fr`.

Codes de retour

201

Invitation créée. url contient le lien magique (vide si deliveryMode=email). emailSentTo indique l'adresse notifiée (null sinon).

400

Paramètres invalides (ex. redirectUrl manquant pour redirect/both).

401

Clé API absente ou invalide.

403

PLATFORM_REQUIRED : la clé n'appartient pas à un marchand disposant d'un contrat Platform actif.

409

DUPLICATE_SESSION : une invitation est déjà active pour ce couple (plateforme, externalRef). PLATFORM_NOT_PROVISIONED : votre compte plateforme n'est pas provisionné pour l'enrôlement de sous-marchands, contactez le support.

429

RATE_LIMITED : trop d'invitations créées sur la période.

Langage

Requête cURLpostExemple

1curl --request POST \

2 --url https://api.mobupay.nc/api/v1/platform/onboarding-sessions \

3 --header 'authorization: Bearer sk_test_XXXX' \

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

5 --data '{ "deliveryMode": "email", "subMerchantContact": { "email": "marchand@example.com", "firstName": "Jean" }, "prefill": { "legalName": "RESTO XYZ SARL", "registrationNumber": "1234567" }, "platformContext": { "externalRef": "partner_42" } }'

Réponse

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

application/json