Créer un client
https://api.mobupay.nc/api/v1/customersCe que fait cet appel
Crée un nouveau client. Un client représente un acheteur récurrent à qui vous pouvez associer des moyens de paiement tokenisés (paiements one-click), des paiements, et des sessions wallet. L'email est unique par marchand. externalId permet de mapper le client à votre identifiant interne (également unique par marchand).
Authorization: Bearer sk_test_XXXXLe 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êteIdempotency-KeystringOptionnelheaderClé d'idempotence facultative (255 caractères au plus, UUID v4 recommandé). Un nouvel envoi de la même demande sous la même clé, dans les 24 heures, rend la réponse de la première exécution sans rien réexécuter. Cf. le guide Idempotence.
Corps de la requête
application/jsonemailstringRequisEmail du client. Format RFC 5322. Unique par marchand : un second appel avec le même email retourné `409 CONFLICT`.
externalIdstringOptionnelVotre identifiant interne du client (ex: ID utilisateur de votre back-office). Unique par marchand. Max 255 caractères.
firstNamestringOptionnelPrenom du client. Max 255 caractères.
lastNamestringOptionnelNom de famille. Max 255 caractères.
phonestringOptionnelNuméro de telephone au format E.164 recommande (ex: `+687781234`). Max 50 caractères.
localestringOptionnelLocale du client pour les emails et la page de paiement (ex: `fr`, `fr_FR`, `en`). 2 a 10 caractères.
metadataobjectOptionnelMétadonnées libres (clé/valeur). Conservées telles quelles, retournées dans les webhooks et les readbacks.
Listes d'adresses de facturation. `send` : envoi des factures, avoirs et devis. `unpaid` : factures impayées et leurs relances. `paid` : factures acquittées (facture d'un paiement). Dix adresses au plus par liste. Une liste passée sur un document **remplace** celle du client, liste par liste : passer seulement `send` garde les listes `unpaid` et `paid` du client. Une liste absente ou vide prend celle du client. Une liste `unpaid` ou `paid` vide retombe sur `send`, et `send` vide sur l'adresse du client. Les listes sont figées à l'émission du document. La première adresse reçoit le courriel, les suivantes en copie. Adresse invalide : `400 ValidationError`, `fields[].message` = `INVALID_BILLING_EMAIL` avec la liste et l'index dans `fields[].field`. Plus de dix adresses : `TOO_MANY_BILLING_EMAILS`. Dans `order.invoicing.recipient`, une adresse invalide est écartée au lieu d'être refusée.
Codes de retour
Client créé.
Paramètres invalides.
CONFLICT : un client avec cet email ou cet externalId existe déjà pour ce marchand. IDEMPOTENCY_KEY_REUSED : la clé a déjà servi à une demande différente. IDEMPOTENCY_REQUEST_IN_PROGRESS : la première demande sous cette clé est encore en cours ; renvoyez-la à l'identique quelques secondes plus tard. Un nouvel envoi de la même demande sous la même clé rend 201 et la fiche d'origine, jamais le 409 de doublon.
Langage
Cliquez sur Essayer pour lancer la requête et voir la réponse ici. Ou choisissez un exemple :
application/json