Chargement de vos clés API…

Suivre les invitations de vos clients

GEThttps://api.mobupay.nc/api/v1/integrator/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 à tous les modules), qui doit agir (actionRequired : client, mobupay, integrator ou none), le consentement (consented) et la progression du dossier (onboarding), sans jamais une pièce, une personne ni un motif.

status décrit le lien : pending, opened (votre client l'a ouvert), accepted (un dossier existe), completed (le compte est ouvert), expired, cancelled.

Filtres : status, enrollmentStatus (liste séparée par des virgules), externalRef, updatedSince (date ISO), limit (1 à 200).

Une clé de test ne lit que les simulations, une clé de production jamais.

Portée de clé requise : integrator.invitations.read (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.

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/integrator/clients/invitations \

3 --header 'authorization: Bearer sk_int_test_XXXX'

Réponse

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

application/json