Clients finaux
Page générée depuis la spécification OpenAPI que la passerelle sert (
GET /v1/openapi.json). Ne la modifiez pas à la main : elle est réécrite à chaque build.
| Méthode | Chemin | Description |
|---|---|---|
GET |
/v1/customers |
Lister vos clients finaux |
POST |
/v1/customers |
Enregistrer un client final |
GET |
/v1/customers/{id} |
Consulter un client final |
PATCH |
/v1/customers/{id} |
Mettre à jour un client final |
GET /v1/customers
Lister vos clients finaux
Vos propres clients finaux. external_id filtre exactement ; search rapproche sur le nom, le téléphone et le courriel. Scope can_read_customers.
Paramètres
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
external_id |
query | non | Votre propre identifiant — filtre exact. |
search |
query | non | |
limit |
query | non | 20 par défaut, 100 au plus. |
offset |
query | non |
Réponses
200— OK401— Clé API manquante ou rejetée403— La clé ne porte pas le scope requis (can_read_customers / can_write_customers), ou le compte n'est pas actif429— Budget de requêtes de la clé dépassé
POST /v1/customers
Enregistrer un client final
Enregistre une personne que vous connaissez déjà, AVANT son premier paiement. Deux effets : un joueur dont vous déclarez avoir vérifié l'âge n'est jamais retenu sur un corridor restreint pour défaut de vérification, et son profil de risque est préchauffé, ce qui sort ce travail du chemin du paiement. Répond 200 avec already_existed: true lorsque la personne était déjà connue : la clé de dédoublonnage est partagée avec le chemin de paiement, donc un « create » tombe souvent sur une fiche que vos propres encaissements ont déjà créée. Scope can_write_customers.
Réponses
200— La personne était déjà connue ; la fiche existante est renvoyée, enrichie des champs qui étaient vides201— Client final créé401— Clé API manquante ou rejetée403— La clé ne porte pas le scope requis (can_read_customers / can_write_customers), ou le compte n'est pas actif422— Vérification d'âge incomplète ou hors vocabulaire429— Budget de requêtes de la clé dépassé
GET /v1/customers/{id}
Consulter un client final
Scope can_read_customers.
Paramètres
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
id |
path | oui | Identifiant du client final. |
Réponses
200— OK401— Clé API manquante ou rejetée403— La clé ne porte pas le scope requis (can_read_customers / can_write_customers), ou le compte n'est pas actif404— Aucun client final avec cet identifiant429— Budget de requêtes de la clé dépassé
PATCH /v1/customers/{id}
Mettre à jour un client final
Champ vide = inchangé. C'est ainsi que vous répondez à une demande de re-vérification (customer.reverification_requested) : envoyez la vérification que vous avez effectuée, et la restriction posée en attendant est levée dans la même transaction. Scope can_write_customers.
Paramètres
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
id |
path | oui | Identifiant du client final. |
Réponses
200— Mis à jour401— Clé API manquante ou rejetée403— La clé ne porte pas le scope requis (can_read_customers / can_write_customers), ou le compte n'est pas actif404— Aucun client final avec cet identifiant422— Vérification d'âge incomplète ou hors vocabulaire429— Budget de requêtes de la clé dépassé