MobupayMobupay
Chargement de vos clés API…

Récupérer une invitation

GEThttps://api.mobupay.nc/api/v1/platform/onboarding-sessions/{id}

Ce que fait cet appel

Réservé aux comptes Platform. Récupère l'état courant d'un enrôlement.

Deux lectures, et il faut les distinguer. status décrit le cycle de vie du LIEN d'invitation : PENDING (lien actif, jamais ouvert), IN_PROGRESS (lien ouvert), COMPLETED (compte ouvert), EXPIRED, CANCELLED. enrollmentStatus décrit l'avancement du DOSSIER, ce qui est presque toujours ce que vous cherchez.

Les onze états d'enrôlement : INVITED (lien jamais ouvert), LINK_OPENED (lien ouvert, dossier pas commencé), DRAFT (dossier en cours de constitution), SUBMITTED (dossier déposé, contrôles en cours), IN_REVIEW (en instruction), CORRECTION_REQUESTED (des corrections sont attendues de votre partenaire), OPENED (compte ouvert, votre partenaire peut encaisser), REFUSED (fin de parcours), SUSPENDED (compte ouvert puis suspendu), EXPIRED (invitation périmée sans dossier ouvert), CANCELLED.

actionRequired répond directement à « dois-je faire quelque chose » : sub_merchant, mobupay, platform ou none. C'est le champ à brancher sur vos relances.

history donne la frise des états traversés, dédupliquée : elle répond à « depuis quand est-ce bloqué », que l'état courant seul ne dit pas.

Aucun motif de refus détaillé, aucune pièce et aucune personne ne figurent dans cette réponse : le dossier de votre partenaire ne vous appartient pas. Un dossier renvoyé en correction est annoncé comme tel, ce qui est demandé ne l'est 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

1 en-tête
idstringRequispath

Identifiant de l'invitation (`mcs_*`).

Codes de retour

200

Invitation trouvée.

403

PLATFORM_REQUIRED : contrat Platform requis.

404

Invitation introuvable pour cette plateforme.

Langage

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