Clients

Lister les clients

GEThttps://tupay.apps.lepetittahitien.dev/api/v1/customers

Les clients supprimés ne figurent pas dans la liste. Ils restent lisibles un par un : cf. GET /customers/{id}.

Paramètres de requête

emailchaîne· requêtefacultatif
exemple client@exemple.pf
Ne rend que les clients portant cette adresse, comparée sans tenir compte de la casse.
Plusieurs fiches peuvent légitimement partager une adresse — un couple, une boîte de service, une refacturation. Tupay n'impose aucune unicité : ce filtre rend une collection, pas un objet.
limitentier· requêtefacultatif
minimum 1maximum 100défaut 25
Nombre d'éléments par page, entre 1 et 100. Vaut 25 par défaut sur toutes les collections.
Une valeur hors bornes est refusée par un 400 validation_error, jamais rabattue en silence sur 100.
starting_afterchaîne· requêtefacultatif
exemple 8f14e45f-ceea-4c1a-9b7d-2a3f6c8e01b4
Curseur. Ne rend que les éléments situés APRÈS celui-ci dans l'ordre de parcours, donc plus anciens. L'élément désigné n'est jamais inclus dans la page.
C'est le paramètre du parcours normal : lisez une page, reprenez avec l'identifiant de son dernier élément.
Ne se combine ni avec ending_before, ni avec offset.
ending_beforechaîne· requêtefacultatif
exemple 8f14e45f-ceea-4c1a-9b7d-2a3f6c8e01b4
Curseur inverse. Ne rend que les éléments situés AVANT celui-ci dans l'ordre de parcours, donc plus récents. L'élément désigné n'est jamais inclus dans la page.
Sous ce paramètre, has_more parle de ce qui reste avant la page, pas après.
Ne se combine ni avec starting_after, ni avec offset.
offsetentier· requêtefacultatif
minimum 0défaut 0
Déprécié, remplacé par starting_after. Reste accepté au minimum douze mois, avec exactement le comportement qu'il a toujours eu.
Pourquoi il est déprécié : un décalage nomme une POSITION dans un classement qui bouge. Dès qu'une ligne naît pendant votre parcours, tout ce qui suit glisse d'un cran, et vous sautez un élément sans rien voir. Un curseur nomme une LIGNE, et ne glisse pas.
Il n'est pas traduit en curseur : un décalage n'a pas d'équivalent en curseur, et prétendre le contraire vous rendrait une position instable rebaptisée.
Ne se combine ni avec starting_after, ni avec ending_before.

Exemple d'appel

cURL

curl -X GET 'https://tupay.apps.lepetittahitien.dev/api/v1/customers' \
  -H 'Authorization: Bearer tpk_test_4f2a9c8e1b6d0a35' \
  -H 'Accept: application/json'

Node

import { Tupay } from 'tupay'

const tupay = new Tupay(process.env.TUPAY_SECRET_KEY!)

const resultat = await tupay.customers.list()

console.log(resultat)

PHP

<?php

// Aucune dépendance : l'extension cURL suffit, et elle est activée par
// défaut sur la quasi-totalité des hébergements PHP.
// En contexte WordPress, préférez wp_remote_request() : cette API-là
// respecte les proxys, certificats et filtres de l'hébergement.

$url = 'https://tupay.apps.lepetittahitien.dev/api/v1/customers';

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($curl, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer tpk_test_4f2a9c8e1b6d0a35',
    'Accept: application/json',
]);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_TIMEOUT, 30);
curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 10);
// Vérification TLS non négociable : sans elle, un intermédiaire pourrait
// se faire passer pour l'API et récolter votre clé secrète.
curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, true);
curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 2);

$reponse = curl_exec($curl);
$statut = curl_getinfo($curl, CURLINFO_HTTP_CODE);
$erreurReseau = curl_error($curl);
curl_close($curl);

if (false === $reponse) {
    throw new RuntimeException('Appel Tupay impossible : ' . $erreurReseau);
}

$donnees = json_decode($reponse, true);

if ($statut >= 400) {
    // Branchez vos traitements sur `error`, le code machine : il est
    // stable, là où le message est susceptible d'évoluer.
    throw new RuntimeException('Tupay a répondu ' . $statut . ' (' . $donnees['error'] . ')');
}

var_dump($donnees);

Les valeurs sont celles d'un compte de test : remplacez la clé et les identifiants par les vôtres.

Console d'essai

Exécuter un appel depuis cette page demande JavaScript. Le guide de prise en main délivre une clé de test et montre les mêmes appels sans JavaScript.

Authentification

Jeton porteur, en-tête Authorization
Authorization: Bearer tpk_live_… ou Authorization: Bearer tpk_test_…

Réponses

200application/json

Collection

- dataliste· de objetfacultatif
  - idchaînefacultatif
    format uuid
  - objectchaînefacultatif
    toujours customer
  - createdentierfacultatif
    Secondes Unix. Même instant que createdAt.
  - emailchaîne ou `null`facultatif
    format email
  - namechaîne ou `null`facultatif
  - phonechaîne ou `null`facultatif
  - metadataobjetfacultatif
    au plus 50 clés
    Clés libres (longueur maximale 40), valeurs de type chaîne (longueur maximale 500).
    ⚠️ Une valeur qui ressemble à un numéro de carte bancaire est REFUSÉE, sur toutes les ressources : Tupay n'en stocke jamais, y compris ici. Ce refus protège votre conformité PCI-DSS autant que la nôtre. Si c'est une référence interne numérique, préfixez-la (« cmd-… ») pour lever l'ambiguïté.
    Vos propres clés et valeurs, attachées à l'objet et relisibles avec lui. De quoi relier une ressource Tupay à votre système sans tenir de table de correspondance.
    Bornes : 50 clés au plus, 40 caractères par clé, 500 par valeur. Elles portent sur le RÉSULTAT de la fusion, pas sur ce que vous envoyez : ajouter 5 clés à un objet qui en compte 48 est refusé.
    À la modification, les clés fournies remplacent les anciennes et les autres survivent. Une clé à null est supprimée. Un objet vide ne change rien, et metadata: null efface tout.
    Ce n'est pas un espace de stockage : les valeurs ne sont ni indexées ni cherchables, et n'ont aucun effet sur le traitement.
  - deletedbooléenfacultatif
    Toujours présent, y compris à false. Un client supprimé reste lisible et garde ses données : seule la fiche est retirée de la liste et fermée à la modification.
  - livemodebooléenfacultatif
  - createdAtchaînefacultatif
    format date-time
    Doublon de created. Lisez created.
  - updatedAtchaînefacultatif
    format date-time
- has_morebooléenfacultatif
  Vrai s'il reste au moins un élément dans le sens du parcours en cours. Calculé sans COUNT(*).
- hasMorebooléenfacultatif
  Déprécié, doublon de has_more et de même valeur. Servi au minimum douze mois, puis retiré par une version datée. Lisez has_more.

400application/json

Requête invalide

Code machine validation_error

Un champ du corps ne respecte pas son contrat (422).

{
  "error": "validation_error",
  "type": "invalid_request",
  "message": "Le montant minimum est de 100 XPF.",
  "code": 422
}

Code machine bad_request
Corps absent ou illisible, paramètre de requête hors bornes (400).
```
{
  "error": "bad_request",
  "type": "invalid_request",
  "message": "Corps JSON invalide.",
  "code": 400
}
```
Langage : json

Code machine invalid_cursor

Curseur de pagination qui ne se résout pas (400).

{
  "error": "invalid_cursor",
  "type": "invalid_request",
  "message": "Le curseur « starting_after » ne désigne aucun élément de cette collection : « 8f14e45f-ceea-4c1a-9b7d-2a3f6c8e01b4 ». Reprenez le parcours depuis le début.",
  "code": 400
}

Code machine missing_idempotency_key

En-tête Idempotency-Key absent sur une opération qui l'exige (400).

{
  "error": "missing_idempotency_key",
  "type": "invalid_request",
  "message": "Header Idempotency-Key obligatoire.",
  "code": 400
}

- errorchaînerequis
  Code machine stable, en snake_case anglais.
- typechaînerequis
  valeurs : invalid_request, authentication, permission, not_found, conflict, idempotency, rate_limit, provider, api
  Classe de l'erreur, dans un ensemble fermé.
  invalid_request : l'appel est mal formé ou hors bornes, corrigez la requête. authentication : aucune identité valide. permission : identité valide, opération refusée. not_found : la ressource n'existe pas, ou pas pour vous. conflict : l'état courant interdit l'opération, ne retentez pas à l'identique. idempotency : le refus porte sur la clé d'idempotence, pas sur la requête. rate_limit : trop d'appels. provider : le prestataire bancaire a refusé ou n'a pas répondu. api : incident de notre côté, rien à corriger chez vous.
- messagechaînerequis
  Destiné à un humain, toujours en français.
- codeentierrequis
  Statut HTTP, repris dans le corps par commodité.

401application/json

Clé absente, invalide ou révoquée

Code machine unauthorized

Aucune identité valide n'a pu être établie.

{
  "error": "unauthorized",
  "type": "authentication",
  "message": "Authentification requise.",
  "code": 401
}

- errorchaînerequis
  Code machine stable, en snake_case anglais.
- typechaînerequis
  valeurs : invalid_request, authentication, permission, not_found, conflict, idempotency, rate_limit, provider, api
  Classe de l'erreur, dans un ensemble fermé.
  invalid_request : l'appel est mal formé ou hors bornes, corrigez la requête. authentication : aucune identité valide. permission : identité valide, opération refusée. not_found : la ressource n'existe pas, ou pas pour vous. conflict : l'état courant interdit l'opération, ne retentez pas à l'identique. idempotency : le refus porte sur la clé d'idempotence, pas sur la requête. rate_limit : trop d'appels. provider : le prestataire bancaire a refusé ou n'a pas répondu. api : incident de notre côté, rien à corriger chez vous.
- messagechaînerequis
  Destiné à un humain, toujours en français.
- codeentierrequis
  Statut HTTP, repris dans le corps par commodité.