Chargement de vos clés API…

Rechercher des clients

GEThttps://api.mobupay.nc/api/v1/customers

Ce que fait cet appel

Recherche un client via la triple identification : customerId, email ou externalId. Tous les critères pointent vers le même client (ils sont uniques par marchand) : si plusieurs sont fournis, ils doivent être cohérents.

La réponse est toujours un TABLEAU, jamais un objet : [client] quand il est trouvé, [] sinon. Il n'y a pas de 404 sur cette route. Sans aucun critère, elle renvoie tous vos clients : pensez à vérifier que votre paramètre est bien transmis.

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

customerIdstringOptionnelquery

Identifiant Mobupay du client (`cus_*`).

emailstring , emailOptionnelquery

Email du client (unique par marchand).

externalIdstringOptionnelquery

Votre identifiant interne du client (unique par marchand).

limitintegerOptionnelquery

Sans critère : taille de page. Défaut 100, maximum 500.

offsetintegerOptionnelquery

Sans critère : rang de départ. Défaut 0.

Codes de retour

200

Tableau des clients correspondants. Vide si aucun ne correspond. Sans critère, la réponse est paginée : l en-tête X-Mobupay-Result-Truncated: true indique qu il reste des clients au-delà de X-Mobupay-Result-Limit.

Langage

Requête cURLgetExemple

1curl --request GET \

2 --url https://api.mobupay.nc/api/v1/customers \

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