neo-pays

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 — OK (object)
  • 401 — Clé API manquante ou rejetée (Error)
  • 403 — La clé ne porte pas le scope requis (can_read_customers / can_write_customers), ou le compte n'est pas actif (Error)
  • 429 — Budget de requêtes de la clé dépassé (Error)

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.

Corps de la requête

Champ Type Requis Description
external_id string non
name string non
phone string non Le téléphone ou le courriel est requis : la fiche est dédoublonnée sur l'un des deux, et une personne sans ni l'un ni l'autre ne pourrait jamais être rapprochée de ses propres paiements.
email string non
country string non
national_id object non
national_id.type string non
national_id.number string non
date_of_birth string non AAAA-MM-JJ.
age_verified boolean non Vous déclarez avoir vérifié que cette personne est majeure. Forme courte de age_verification_status.
age_verification_status string non
age_verified_at string non RFC3339.
age_verification_method string non

Réponses

  • 200 — La personne était déjà connue ; la fiche existante est renvoyée, enrichie des champs qui étaient vides (Customer)
  • 201 — Client final créé (Customer)
  • 401 — Clé API manquante ou rejetée (Error)
  • 403 — La clé ne porte pas le scope requis (can_read_customers / can_write_customers), ou le compte n'est pas actif (Error)
  • 422 — Vérification d'âge incomplète ou hors vocabulaire (Error)
  • 429 — Budget de requêtes de la clé dépassé (Error)

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 — OK (Customer)
  • 401 — Clé API manquante ou rejetée (Error)
  • 403 — La clé ne porte pas le scope requis (can_read_customers / can_write_customers), ou le compte n'est pas actif (Error)
  • 404 — Aucun client final avec cet identifiant (Error)
  • 429 — Budget de requêtes de la clé dépassé (Error)

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.

Corps de la requête

Champ Type Requis Description
external_id string non
name string non
phone string non Le téléphone ou le courriel est requis : la fiche est dédoublonnée sur l'un des deux, et une personne sans ni l'un ni l'autre ne pourrait jamais être rapprochée de ses propres paiements.
email string non
country string non
national_id object non
national_id.type string non
national_id.number string non
date_of_birth string non AAAA-MM-JJ.
age_verified boolean non Vous déclarez avoir vérifié que cette personne est majeure. Forme courte de age_verification_status.
age_verification_status string non
age_verified_at string non RFC3339.
age_verification_method string non

Réponses

  • 200 — Mis à jour (Customer)
  • 401 — Clé API manquante ou rejetée (Error)
  • 403 — La clé ne porte pas le scope requis (can_read_customers / can_write_customers), ou le compte n'est pas actif (Error)
  • 404 — Aucun client final avec cet identifiant (Error)
  • 422 — Vérification d'âge incomplète ou hors vocabulaire (Error)
  • 429 — Budget de requêtes de la clé dépassé (Error)

Schémas

Les formes renvoyées par les opérations ci-dessus.

Error

Champ Type Description
error object
error.code string
error.message string

Customer

Un client final du marchand — la personne qui paie. Ce que vous enregistrez ici sert deux choses : vos joueurs vérifiés ne sont jamais retenus sur un corridor restreint faute de vérification d'âge, et leur profil de risque est préchauffé avant leur premier paiement. Aucun état de conformité n'est jamais renvoyé sur cette ressource.

Champ Type Description
id string Identifiant du client final.
external_id string Votre propre identifiant pour cette personne.
name string
phone string E.164 ou national ; normalisé côté serveur. Le téléphone prime sur le courriel comme clé de dédoublonnage.
email string
country string ISO 3166-1 alpha-2.
national_id object Pièce d'identité, telle que vous l'avez saisie.
national_id.type string cni, passport, …
national_id.number string
date_of_birth string AAAA-MM-JJ.
age_verification object L'état de la vérification d'âge. Il n'affirme JAMAIS un âge : il enregistre qu'une vérification existe, quand, comment et par qui. Absent tant qu'aucune vérification n'a été déclarée — ce qui n'est pas la même chose que « non vérifié ».
age_verification.status string
age_verification.verified_at string RFC3339.
age_verification.method string
age_verification.source string
created_at string