Enregistrements de carte

Statut d'un enregistrement

GEThttps://tupay.apps.lepetittahitien.dev/api/v1/setup-intents/{id}

Sur un échec, la réponse porte deux champs :

- failureCode — un code machine STABLE, sur lequel écrire un if sans jamais lire le message ; - failureMessage — une phrase en français, montrable telle quelle à votre client.

⚠️ clientSecret n'est pas rendu ici.

Paramètres de chemin

idchaîne· cheminrequis
format uuidexemple 8f14e45f-ceea-4c1a-9b7d-2a3f6c8e01b4

Paramètres de requête

expand[]liste· requêtefacultatif
Développe une référence : le champ porte l'objet complet au lieu de son seul identifiant, qui reste servi. Répétez le paramètre pour plusieurs chemins.
Chemins acceptés : payment_method → customer ; payment_link → price ; price → product ; setup_intent → customer, payment_method ; transaction → payment_method ; transaction → payment_link, customer ; refund → transaction, transaction.payment_link, transaction.customer ; webhook_delivery → event. Un chemin inconnu vaut 400, en énumérant les chemins acceptés.
Profondeur maximale : 2. Au delà, 400 : un expand sans borne est une attaque par amplification.

Exemple d'appel

cURL

curl -X GET 'https://tupay.apps.lepetittahitien.dev/api/v1/setup-intents/8f14e45f-ceea-4c1a-9b7d-2a3f6c8e01b4' \
  -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.setupIntents.retrieve('8f14e45f-ceea-4c1a-9b7d-2a3f6c8e01b4')

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/setup-intents/8f14e45f-ceea-4c1a-9b7d-2a3f6c8e01b4';

$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

Enregistrement

- dataobjetfacultatif
  Une intention d'ENREGISTREMENT de carte. Elle ne porte aucun montant, et n'en acceptera jamais : aucun débit ne peut venir de cet objet.
  - idchaînefacultatif
    format uuid
  - objectchaînefacultatif
    toujours setup_intent
  - createdentierfacultatif
    Secondes Unix. Même instant que createdAt.
  - customerIdchaînefacultatif
    format uuid
    Développable — expand[]=customer.
  - statuschaînefacultatif
    valeurs : pending, succeeded, failed, canceled
  - paymentMethodIdchaîne ou `null`facultatif
    format uuid
    Le moyen créé quand l'enregistrement aboutit, null avant. Développable — expand[]=payment_method.
  - failureCodechaîne ou `null`facultatif
    valeurs : card_declined, expired_card, incorrect_cvc, insufficient_funds, processing_error, authentication_required, null
    Code machine STABLE. authentication_required n'est pas un refus : le porteur doit valider son authentification forte, ramenez-le devant son écran.
  - failureMessagechaîne ou `null`facultatif
    Phrase française, montrable telle quelle au client final.
  - 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.
  - livemodebooléenfacultatif
  - createdAtchaînefacultatif
    format date-time
    Doublon de created. Lisez created.
  - updatedAtchaînefacultatif
    format date-time

404application/json

Ressource inexistante, hors de votre périmètre, ou appartenant à l'AUTRE MODE. Nous renvoyons 404 plutôt que 403 pour ne pas confirmer l'existence de ce qui ne vous appartient pas.

Code machine not_found

Inexistante, ou appartenant à un autre marchand.

{
  "error": "not_found",
  "type": "not_found",
  "message": "Ressource introuvable.",
  "code": 404
}

- 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é.