Chargement de vos clés API…

Lister les invitations

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

Ce que fait cet appel

Réservé aux comptes Platform. Liste les invitations (sessions d'onboarding) émises par votre plateforme, de la plus récente à la plus ancienne. Filtrable par statut.

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

5 en-têtes

statusstringOptionnelquery

Filtre sur le cycle de vie du LIEN d'invitation : `PENDING`, `IN_PROGRESS`, `COMPLETED`, `EXPIRED`, `CANCELLED`. Pour filtrer sur l'avancement du DOSSIER, utilisez `enrollmentStatus`.

enrollmentStatusstringOptionnelquery

Filtre sur l'état d'enrôlement, une ou plusieurs valeurs séparées par des virgules. Exemple : `CORRECTION_REQUESTED,DRAFT` pour tous les dossiers en attente d'une action de votre partenaire.

externalRefstringOptionnelquery

Filtre exact sur la référence que vous avez fournie à la création (`platformContext.externalRef`).

updatedSincestring , date-timeOptionnelquery

Ne renvoie que les enrôlements dont l'invitation OU le dossier a bougé depuis cette date (ISO 8601). C'est l'appel de rattrapage après une interruption de votre côté.

limitintegerOptionnelquery

Nombre maximum de résultats (1 à 200, défaut 50).

Codes de retour

200

Liste des invitations.

403

PLATFORM_REQUIRED : contrat Platform requis.

Langage

Requête cURLgetExemple

1curl --request GET \

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

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