# StampyWallet Documentation

> The documentation for StampyWallet, the loyalty card in Apple Wallet and Google Wallet for local businesses: the merchant guide, the MCP server and its tools, the API and webhooks, and the "beautiful cards" skill.

Every link leads to the Markdown version of the page. The same page is also returned when its regular address is requested with the `Accept: text/markdown` header.

The whole documentation in a single file: [llms-full.txt](https://stampywallet.com/en/docs/llms-full.txt).
The product, pricing, features and the rest of the site: [llms.txt](https://stampywallet.com/llms.txt).

## Guide

### Getting started

- [Welcome to the StampyWallet documentation](https://stampywallet.com/en/docs/index.md): StampyWallet is a loyalty card in Apple Wallet and Google Wallet, with no app to install. Here is everything you need to create it, scan it at the counter, and run it from an AI assistant or your point of sale.
- [Create your card in 5 minutes](https://stampywallet.com/en/docs/guide/create-your-card.md): Open your account, choose your card type, customize it, try it on your phone and print the counter poster.
- [Card types](https://stampywallet.com/en/docs/guide/card-types.md): A StampyWallet card works in one of three modes, stamps, multiple rewards (tiers) or points, and each mode comes in several shapes.

### At the counter

- [Scan a card at the counter](https://stampywallet.com/en/docs/guide/scanning.md): Add a stamp or points, give a reward, undo a mistake, find a customer without the camera and keep working offline.
- [Your team](https://stampywallet.com/en/docs/guide/team.md): Invite your staff and managers, see what each role can do, and track the stamps each person adds. Unlimited team on every plan.

### Bring them back

- [Messages and notifications](https://stampywallet.com/en/docs/guide/messages.md): Message your customers on their phone's lock screen, target a group, schedule a send, and let reminders, win-back messages and birthdays go out on their own.
- [Gift cards and packages](https://stampywallet.com/en/docs/guide/gift-cards-and-packages.md): Sell gift cards and prepaid packages at the counter, send them to the Wallet, then redeem them with a scan.
- [Google reviews](https://stampywallet.com/en/docs/guide/google-reviews.md): Ask every customer for a Google review at the right moment, with a direct link to your listing, no filtering and no reward, within Google's rules.

## MCP and AI

### Connect

- [Connect an AI assistant](https://stampywallet.com/en/docs/mcp/connect.md): The StampyWallet MCP server connects Claude, ChatGPT, Cursor or an agent to your loyalty card. One address, no key, and nothing changes without your approval.
- [Connect Claude](https://stampywallet.com/en/docs/mcp/claude.md): Add StampyWallet as a custom connector in Claude (web, desktop and mobile), then connect your account.
- [Connect ChatGPT](https://stampywallet.com/en/docs/mcp/chatgpt.md): Add the StampyWallet MCP server as a connector in ChatGPT, then connect your StampyWallet account.
- [Connect Cursor and agents](https://stampywallet.com/en/docs/mcp/cursor.md): Declare the StampyWallet MCP server in Cursor, Claude Code, VS Code or any MCP-compatible agent.

### Tools without an account

- [concevoir_carte](https://stampywallet.com/en/docs/mcp/tools/concevoir_carte.md): Concevoir une carte de fidélité
- [simuler_fidelite](https://stampywallet.com/en/docs/mcp/tools/simuler_fidelite.md): Simuler le coût d’une carte de fidélité
- [creer_commerce](https://stampywallet.com/en/docs/mcp/tools/creer_commerce.md): Mettre la carte de fidélité en service

### Tools with an account

- [tableau_de_bord](https://stampywallet.com/en/docs/mcp/tools/tableau_de_bord.md): Tableau de bord du commerce
- [rentabilite](https://stampywallet.com/en/docs/mcp/tools/rentabilite.md): Ce que rapporte la carte
- [meilleurs_moments](https://stampywallet.com/en/docs/mcp/tools/meilleurs_moments.md): Meilleurs jours et heures
- [chercher_clients](https://stampywallet.com/en/docs/mcp/tools/chercher_clients.md): Chercher des clients
- [fiche_client](https://stampywallet.com/en/docs/mcp/tools/fiche_client.md): Fiche d’un client
- [envoyer_message](https://stampywallet.com/en/docs/mcp/tools/envoyer_message.md): Envoyer un message aux clients
- [lister_messages_recurrents](https://stampywallet.com/en/docs/mcp/tools/lister_messages_recurrents.md): Voir les messages récurrents
- [programmer_message_recurrent](https://stampywallet.com/en/docs/mcp/tools/programmer_message_recurrent.md): Programmer un message récurrent
- [modifier_message_recurrent](https://stampywallet.com/en/docs/mcp/tools/modifier_message_recurrent.md): Modifier un message récurrent
- [suspendre_message_recurrent](https://stampywallet.com/en/docs/mcp/tools/suspendre_message_recurrent.md): Mettre en pause un message récurrent
- [reprendre_message_recurrent](https://stampywallet.com/en/docs/mcp/tools/reprendre_message_recurrent.md): Reprendre un message récurrent
- [arreter_message_recurrent](https://stampywallet.com/en/docs/mcp/tools/arreter_message_recurrent.md): Arrêter un message récurrent
- [historique_messages](https://stampywallet.com/en/docs/mcp/tools/historique_messages.md): Historique des messages
- [regler_automatismes](https://stampywallet.com/en/docs/mcp/tools/regler_automatismes.md): Messages automatiques
- [lister_fermetures](https://stampywallet.com/en/docs/mcp/tools/lister_fermetures.md): Voir les congés et fermetures
- [ajouter_conges](https://stampywallet.com/en/docs/mcp/tools/ajouter_conges.md): Ajouter des congés
- [supprimer_conges](https://stampywallet.com/en/docs/mcp/tools/supprimer_conges.md): Supprimer des congés
- [regler_jours_fermes](https://stampywallet.com/en/docs/mcp/tools/regler_jours_fermes.md): Régler les jours fermés chaque semaine
- [avis_google](https://stampywallet.com/en/docs/mcp/tools/avis_google.md): Avis Google
- [voir_carte](https://stampywallet.com/en/docs/mcp/tools/voir_carte.md): Voir ma carte de fidélité
- [modifier_carte](https://stampywallet.com/en/docs/mcp/tools/modifier_carte.md): Modifier ma carte de fidélité
- [fiche_commerce](https://stampywallet.com/en/docs/mcp/tools/fiche_commerce.md): Fiche du commerce
- [affichette](https://stampywallet.com/en/docs/mcp/tools/affichette.md): Affichette et QR code
- [envoyer_affichette](https://stampywallet.com/en/docs/mcp/tools/envoyer_affichette.md): Recevoir l’affichette par e-mail
- [lister_equipe](https://stampywallet.com/en/docs/mcp/tools/lister_equipe.md): Voir l’équipe
- [inviter_membre](https://stampywallet.com/en/docs/mcp/tools/inviter_membre.md): Inviter un membre de l’équipe
- [changer_role_membre](https://stampywallet.com/en/docs/mcp/tools/changer_role_membre.md): Changer le rôle d’un membre
- [retirer_membre](https://stampywallet.com/en/docs/mcp/tools/retirer_membre.md): Retirer un membre de l’équipe
- [annuler_invitation](https://stampywallet.com/en/docs/mcp/tools/annuler_invitation.md): Annuler une invitation

## API and webhooks

### Get started

- [The StampyWallet API](https://stampywallet.com/en/docs/api.md): Add visits, create customers and receive your loyalty card's events from your POS, your website or a no-code tool.
- [Authentication](https://stampywallet.com/en/docs/api/authentication.md): Every API call carries a secret sw_live_ key, created in Settings › Integrations and shown only once. 120 requests per minute per key.
- [Errors and retries](https://stampywallet.com/en/docs/api/errors.md): The API error format, all error codes, and the Idempotency-Key header to retry a POST with no risk of duplicates.

### Reference

- [Get the business](https://stampywallet.com/en/docs/api/shop.md): GET /v1/commerce returns the profile of the business linked to the key and the rules of its loyalty card.
- [Create a customer](https://stampywallet.com/en/docs/api/create-customer.md): POST /v1/clients signs a customer up to the loyalty program and returns their card link, to send them by SMS or email.
- [Find a customer](https://stampywallet.com/en/docs/api/find-customers.md): GET /v1/clients finds a customer by their phone, email or card code.
- [Get a customer](https://stampywallet.com/en/docs/api/get-customer.md): GET /v1/clients/:id returns a customer and the state of their loyalty card, stamps, points and rewards to give.
- [Add a visit](https://stampywallet.com/en/docs/api/add-visit.md): POST /v1/passages adds a stamp or points to a customer's card from your POS, and tells you whether a reward is earned.
- [Cancel a visit](https://stampywallet.com/en/docs/api/cancel-visit.md): DELETE /v1/passages/:id removes a customer's last visit, for example after a receipt is voided or refunded at the register.
- [Give a reward](https://stampywallet.com/en/docs/api/give-reward.md): POST /v1/recompenses marks a reward earned by a customer as given, from your POS.

### Webhooks

- [Webhooks](https://stampywallet.com/en/docs/api/webhooks.md): Receive a signed HTTP call on your server, Zapier, Make or n8n on every visit, reward or new card, and verify its HMAC signature.
- [Event list](https://stampywallet.com/en/docs/api/events.md): The nine events sent by StampyWallet webhooks, when they are sent, and the exact content of their donnees field.

### POS systems

- [Receive events from your POS](https://stampywallet.com/en/docs/api/incoming.md): POST /v1/entrants/:jeton receives sales from Square, Shopify, SumUp, Zettle or any tool, and adds the visit to the right customer.
- [Connect your POS](https://stampywallet.com/en/docs/api/connect-your-pos.md): Step-by-step settings so Square, Shopify, SumUp, Zettle, Zapier, Make or n8n add a stamp on every sale, with no developer.

## skill.md

- [Install the "beautiful cards" skill](https://stampywallet.com/en/docs/skill/index.md): A Markdown file that teaches your AI assistant to design a business's loyalty cards the way we do: its real images first, the fourteen card shapes, icons that say what the reward is, and a review before showing anything.
- [What the skill does](https://stampywallet.com/en/docs/skill/method.md): The fourteen card shapes, real images first, licensed icons when the photos don't fit, and a review of every card before showing it.