Tapez au moins deux caractères. Les flèches parcourent les résultats, Entrée ouvre le résultat courant, Échap ferme la liste. La touche barre oblique amène à ce champ.

Référence API

Version 2026-01-01 · 66 opérations sur 45 chemins · URL de base https://tupay.apps.lepetittahitien.dev/api/v1

Passerelle de paiement pour la Polynésie française. Encaissement en XPF.

Montants : toujours des entiers XPF. Le franc pacifique n'a pas de centimes. amountEurCents est exposé en centimes EUR pour la seule réconciliation avec le prestataire bancaire ; le XPF fait foi.

Modes : une clé tpk_test_ opère sur un jeu de données totalement étanche au réel. Aucun argent ne bouge, aucun appel n'atteint le prestataire bancaire.

Un premier encaissement de bout en bout : /docs

Vous intégrez Tupay pour la première fois ? Le guide de prise en main raconte un premier encaissement de bout en bout. Cette page-ci est la référence exhaustive : elle décrit tout, dans l'ordre de la spécification.

Paiements

Liens de paiement

Enregistrements de carte

Enregistrer une carte à l'inscription pour prélever plus tard, sans rien redemander au porteur.

Aucun montant n'est en jeu. Ni la requête, ni l'objet, ni la table ne portent de somme : il est structurellement impossible de débiter par ce chemin.

Moyens de paiement

Enregistrer une carte pour ne pas la redemander.

Tupay ne reçoit jamais de numéro de carte. La carte est tokenisée dans le navigateur du porteur, chez le prestataire, sur son domaine à lui ; vous ne nous transmettez que le jeton obtenu. C'est ce qui maintient votre intégration — et la nôtre — dans le périmètre PCI-DSS SAQ A, le plus léger.

Catalogue

Déclarer une fois ce que vous vendez, puis encaisser en pointant l'article plutôt qu'en recopiant libellé et montant.

Un article se désactive, il ne se supprime pas : l'état est réversible, et ses tarifs existants continuent de fonctionner.

Reçus

La preuve de paiement envoyée au client final, pas à vous.

Elle part toute seule dès qu'un paiement aboutit avec une adresse connue — celle de la fiche client rattachée, ou celle saisie dans le tunnel. Vous n'avez rien à déclencher.

Ces routes sont le journal : à quelle adresse, quand, et ce qui a échoué. Un envoi qui rate ne remet jamais un encaissement en cause.

Sessions de paiement

Une page de paiement hébergée par Tupay, à laquelle vous envoyez votre client. Vous n'affichez ni formulaire, ni montant : la session porte les deux.

Le total est figé à la création. Modifier ou désactiver un tarif ensuite ne change pas ce que la session affiche — le prix montré au client est celui qu'il paiera.

Une session ne se règle qu'une fois. Un second paiement est refusé en 409, y compris pendant que le premier est encore en cours chez la banque. La garantie est tenue par la base, pas par la route.

Abonnements

Lier un client à un tarif récurrent, pour encaisser sans y penser.

Un abonnement condamné est refusé à la création. Un client sans moyen de paiement, ou un tarif ponctuel, valent une erreur qui nomme la cause — plutôt qu'un abonnement qui échouera à sa première échéance, du côté du client.

Factures

Émises automatiquement à l'échéance d'un abonnement, et prélevées dans la foulée sur la carte enregistrée.

Les montants sont TTC. La TGC y est comprise et non ajoutée : htXpf + tgcXpf vaut exactement amountXpf, toujours, et la base le vérifie.

Une facture émise ne se réécrit pas. Elle conserve le taux et les montants qu'elle portait, même si vous changez de régime demain.

Un prélèvement refusé est relancé selon un barème en jours — 1 j → 3 j → 5 j → 7 j, cinq tentatives sur seize jours. Chacune est journalisée. Au bout, la facture passe en souffrance et l'abonnement avec ; nous ne résilions jamais à votre place.

Clients

Le carnet d'adresses du marchand : reconnaître une personne d'un paiement à l'autre plutôt que de traiter chaque encaissement comme un inconnu de passage.

Transactions

Remboursements

Webhooks

Événements

Ce que Tupay a émis, indépendamment de ce qui a été livré.

Clés API

Marchand

Mode test

Bac à sable

Obtenir une clé de test sans inscription ni validation humaine.

Terminal

Encaissement au comptoir depuis l'application mobile Tupay.

Ces routes n'acceptent pas les clés API. Elles sont authentifiées par la session du marchand ; cf. le schéma de sécurité SessionCookie.

Argent

Objets

Les 22objets que l'API renvoie, champ par champ, avec leur type et leurs contraintes : chapitre des objets.

Erreurs

Les 8réponses d'erreur communes à l'API, avec leur code machine et un exemple de corps : chapitre des erreurs.