MobupayMobupay
Chargement de vos clés API…

Suivre vos invitations

GEThttps://staging.mobupay.nc/api/v1/agency/clients/invitations

Ce que fait cet appel

Suivi de vos invitations, la plus récente d'abord.

Chaque invitation porte l'état de l'enrôlement (enrollmentStatus, onze valeurs communes à la plateforme et à l'agence), qui doit agir (actionRequired : client, agency, mobupay ou none) et la progression du dossier (onboarding), sans jamais une pièce, une personne ni un motif.

status décrit le lien : pending, opened (le client l'a ouvert), accepted (un dossier existe, ou un marchand déjà ouvert l'a accepté), expired, revoked. Une invitation dont l'échéance est passée se lit expired même avant le passage de la tâche planifiée.

Filtres : status, enrollmentStatus (liste séparée par des virgules), externalRef, updatedSince (date ISO, activité de l'invitation ou de son dossier), limit (1 à 200, 50 par défaut).

Une clé de test ne lit que les simulations, une clé de production jamais. Le jeton n'est pas relu : il est rendu une seule fois, à la création.

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
enrollmentStatusstringOptionnelquery

Une ou plusieurs valeurs, séparées par des virgules.

externalRefstringOptionnelquery
updatedSincestring , date-timeOptionnelquery
limitintegerOptionnelquery

Codes de retour

200

Vos invitations.

Langage

Requête cURLgetExemple
1curl --request GET \
2 --url https://api.mobupay.nc/api/v1/agency/clients/invitations \
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