8 endpoints
Clients
Le référentiel de vos clients finaux et de leurs moyens de paiement enregistrés — réutilisés par les abonnements et les encaissements récurrents.
Les intitulés et descriptions d'endpoints viennent du contrat OpenAPI, en anglais — ils ne peuvent pas diverger de l'API.
En clair
Votre répertoire de clients, et leurs cartes enregistrées avec leur accord.
Quand l'utiliser
Dès que vous voulez reconnaître un client d'un paiement à l'autre : facturation récurrente, carte enregistrée réutilisée par les abonnements, ou simplement un historique par client.
Comment l'intégrer
- 1Créez le client une fois, gardez son identifiant de votre côté.
- 2Listez ses moyens de paiement enregistrés pour lui proposer de repayer sans ressaisir sa carte.
- 3Désignez un moyen par défaut — c'est celui que prendra un abonnement.
- 4Supprimez un moyen de paiement dès que le client le demande : c'est sa donnée, pas la vôtre.
- GET
/v1/clients/{id}Récupérer un client - PUT
/v1/clients/{id}Mettre à jour un client - DELETE
/v1/clients/{id}Supprimer un client - POST
/v1/clients/{id}/payment-methods/{paymentMethodId}/defaultDéfinir le moyen de paiement par défaut d'un client - GET
/v1/clientsLister les clients - POST
/v1/clientsCréer un client - GET
/v1/clients/{id}/payment-methodsLister les moyens de paiement enregistrés d'un client - DELETE
/v1/clients/{id}/payment-methods/{paymentMethodId}Supprimer un moyen de paiement d'un client
Récupérer un client
Récupère un client à partir de son UUID.
| Champ | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
id | string (uuid) | path | Requis | UUID du client. |
Mettre à jour un client
Met à jour le nom, l'e-mail et/ou le téléphone d'un client.
Schéma · UpdateClientRequest
| Champ | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
id | string (uuid) | path | Requis | |
name | string | body | Optionnel | Nom complet du client. Facultatif ; appliqué uniquement s'il est présent. |
email | string | body | Optionnel | Adresse e-mail du client. Facultative ; appliquée uniquement si présente. |
phone | string | body | Optionnel | Numéro de téléphone du client. Facultatif ; appliqué uniquement si présent. |
Supprimer un client
Supprime un client. Renvoie 204 No Content. Échoue si le client a encore des abonnements actifs.
| Champ | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
id | string (uuid) | path | Requis |
Définir le moyen de paiement par défaut d'un client
Définit un moyen de paiement appartenant au client comme moyen par défaut pour les nouveaux abonnements à prélèvement automatique.
| Champ | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
id | string (uuid) | path | Requis | |
paymentMethodId | string (uuid) | path | Requis |
Lister les clients
Renvoie les clients enregistrés du compte sous forme de Page paginée.
| Champ | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
origin | enum | query | Optionnel | Filtrer par origine de création (API ou DASHBOARD).Valeurs APIDASHBOARD |
pageable | Pageable | query | Requis |
Créer un client
Crée une fiche client réutilisable pour ce compte.
Schéma · CreateClientRequest
| Champ | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
name | string | body | Requis | Nom complet du client. |
email | string | body | Optionnel | E-mail du client, facultatif. |
phone | string | body | Optionnel | Téléphone du client, facultatif (format E.164). |
Lister les moyens de paiement enregistrés d'un client
Renvoie les identifiants locaux sûrs du moyen de paiement et les métadonnées masquées de la carte. Les jetons de carte du prestataire, le CVV en clair et le CVV chiffré ne sont jamais renvoyés.
| Champ | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
id | string (uuid) | path | Requis |
Supprimer un moyen de paiement d'un client
Supprime le jeton du fournisseur et supprime logiquement son miroir local. Les abonnements qui l'utilisent basculent vers un checkout avec client présent lors de leur prochaine tentative.
| Champ | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
id | string (uuid) | path | Requis | |
paymentMethodId | string (uuid) | path | Requis |
Une question sur l'intégration ?
Notre équipe technique répond aux intégrateurs, du premier appel en sandbox jusqu'à la mise en production.