# VEXiON cards

> VEXiON cards public API, integrations, and knowledge base. Build loyalty programs, gift cards, and digital wallet passes for any POS or e-commerce platform.

## API Reference

### API Reference

- [Introduction](https://vexioncards.mintlify.app/api-reference/introduction.md): Understand the base URL, authentication, response codes, and headers you'll use everywhere.
- [Quickstart](https://vexioncards.mintlify.app/api-reference/quickstart.md): Enroll a customer and award their first stamp - five minutes, three requests.
- [Custom Cards](https://vexioncards.mintlify.app/api-reference/custom-cards.md): The card type with no loyalty mechanics: model your own data with custom fields, write it per customer, and render it on the wallet pass.
- [Testing and environments](https://vexioncards.mintlify.app/api-reference/test-mode.md): Build against a sandbox environment, then switch to production by changing the base URL and the key.
- [Pagination](https://vexioncards.mintlify.app/api-reference/pagination.md): How to page through list endpoints using cursor pagination.
- [Rate Limits](https://vexioncards.mintlify.app/api-reference/rate-limits.md): How rate limiting works, per-endpoint limits, and how to handle 429 responses.
- [Idempotency](https://vexioncards.mintlify.app/api-reference/idempotency.md): Make POST requests safe to retry using the Idempotency-Key header.
- [Errors](https://vexioncards.mintlify.app/api-reference/errors.md): The error envelope, common error codes, and how to debug failed requests.
- [Money and currency](https://vexioncards.mintlify.app/api-reference/money-and-currency.md): How amounts, currencies and money limits work in the VEXiON cards API: minor units, the business currency, the largest bill and cashback limits.
- [Versioning](https://vexioncards.mintlify.app/api-reference/versioning.md): URL-versioned major, additive-only inside v1, so your integration never breaks under you.
- [Changelog](https://vexioncards.mintlify.app/api-reference/changelog.md): Every change to the VEXiON cards Public API, dated. Entries are never deleted or rewritten.
- [Webhooks](https://vexioncards.mintlify.app/api-reference/webhooks.md): Receive events the moment they happen - HMAC verification, retries, and the security checklist.

### MCP server

- [VEXiON MCP server](https://vexioncards.mintlify.app/ai/mcp-server.md): Run your loyalty program from Claude, ChatGPT, Cursor and other AI assistants. Connect once, then look up customers, record transactions, build cards and send notifications in plain language.
- [Permissions and security](https://vexioncards.mintlify.app/ai/mcp-permissions.md): Choose what an AI assistant may do in your business, see what it can never do, revoke access at any time, and report a security problem.
- [Tools](https://vexioncards.mintlify.app/ai/mcp-tools.md): All 31 tools of the VEXiON MCP server: what each does, the access it needs, which ones ask for confirmation, and the limits for notifications and reports.

### Customers

- [List customers](https://vexioncards.mintlify.app/api-reference/customers/list-customers.md): Returns a cursor-paginated list of customers in the calling organization, sorted by `created_at` **descending** (newest first).
- [Upsert a customer](https://vexioncards.mintlify.app/api-reference/customers/upsert-a-customer.md): Enrolls a new customer on a specific card template, or upserts an existing one.
- [Retrieve a customer](https://vexioncards.mintlify.app/api-reference/customers/retrieve-a-customer.md): Retrieves a single customer by ID.
- [Delete a customer (GDPR soft-delete)](https://vexioncards.mintlify.app/api-reference/customers/delete-a-customer-gdpr-soft-delete.md): Removes a customer. Two modes, selected by the `mode` query parameter.
- [Update a customer](https://vexioncards.mintlify.app/api-reference/customers/update-a-customer.md): Updates a customer record. Only fields present in the body are changed.
- [Send the wallet card to the customer by email or SMS](https://vexioncards.mintlify.app/api-reference/customers/send-the-wallet-card-to-the-customer-by-email-or-sms.md): Sends (or re-sends) the wallet claim link to the customer over email, SMS, or both. Subject to a 5-minute per-channel cooldown to prevent abuse: a tight retry loop returns 429. The customer must already have the contact field for the chosen channel (email for `channel=email`, phone for `channel=sms`…

### Cards

- [List card templates](https://vexioncards.mintlify.app/api-reference/cards/list-card-templates.md): Returns a cursor-paginated list of card TEMPLATES in the calling organization.
- [Create a card template](https://vexioncards.mintlify.app/api-reference/cards/create-a-card-template.md): Creates a new card template.
- [Retrieve a card template](https://vexioncards.mintlify.app/api-reference/cards/retrieve-a-card-template.md): Retrieve a single card template by id. Returns the full Card object including design, pass_fields, mechanics, form_builder, referral configuration, issuer details, terms, registration URLs (with per-location variants), and live issued_count. Returns 404 if the card does not exist or is archived in a…
- [Archive a card template (soft delete)](https://vexioncards.mintlify.app/api-reference/cards/archive-a-card-template-soft-delete.md): Archive a card template (soft delete). Existing customers enrolled in the card keep their wallet passes and continue to earn/redeem; the card is removed from the public catalog and POST /v1/customers with this card_id returns 404. To permanently delete with GDPR right-to-be-forgotten (PII anonymizat…
- [Update a card template](https://vexioncards.mintlify.app/api-reference/cards/update-a-card-template.md): Update a card template. Send only the fields you want to change (partial update). The card.type is IMMUTABLE - to change type, archive this card and create a new one. The card.id is also immutable. Most updates take effect immediately and propagate to all enrolled customers' wallet passes via silent…
- [Reissue a reusable coupon](https://vexioncards.mintlify.app/api-reference/cards/reissue-a-reusable-coupon.md): Mass-reactivates a reusable coupon: every holder whose `couponstatus` is currently `redeemed` flips back to usable (the wallet pass QR reappears, the offer field renders again), and the refreshed pass content is pushed to every installed holder so the change is visible without asking anyone to reins…

### Transactions

- [List transactions](https://vexioncards.mintlify.app/api-reference/transactions/list-transactions.md): Lists ledger entries newest first (`created_at desc, id desc` tiebreak). Cursor pagination: default 25, max 100; filters compose with the cursor.
- [Create a transaction](https://vexioncards.mintlify.app/api-reference/transactions/create-a-transaction.md): Records a loyalty action against a customer's card. You describe the real-world event with exactly **two verbs** - `award` or `redeem` - and the server derives the concrete `type`, computes the balance, and snapshots tier state.
- [Retrieve a transaction](https://vexioncards.mintlify.app/api-reference/transactions/retrieve-a-transaction.md): Returns a single ledger entry by id.
- [Reverse a transaction](https://vexioncards.mintlify.app/api-reference/transactions/reverse-a-transaction.md): Posts a compensating entry that exactly negates the original. The reversal is itself a transaction (`kind: "reversal"`, `type: "reversal"`, original type under `reverses.type`); the original becomes `reversed: true` with a `reversed_by` pointer. **Both rows stay in the ledger forever.**

### Products

- [List products](https://vexioncards.mintlify.app/api-reference/products/list-products.md): Lists catalog entries **org-wide**, newest first - filter by `location_id` to see one location's catalog. Scope: `products:read`.
- [Create a product](https://vexioncards.mintlify.app/api-reference/products/create-a-product.md): Creates a **manual catalog entry** at one location. Scope: `products:write`.
- [Retrieve a product](https://vexioncards.mintlify.app/api-reference/products/retrieve-a-product.md): Returns one catalog entry. POS-synced products carry a read-only `pos_ref` (the mapping to the location's till - sync-owned, vendor never surfaced); manual and API entries have `pos_ref: null`. Scope: `products:read`.
- [Update a product](https://vexioncards.mintlify.app/api-reference/products/update-a-product.md): Edits catalog metadata. Scope: `products:write`.

### Notifications

- [List notifications](https://vexioncards.mintlify.app/api-reference/notifications/list-notifications.md): Returns a cursor-paginated list of broadcasts in the calling organization, newest first.
- [Send a notification](https://vexioncards.mintlify.app/api-reference/notifications/send-a-notification.md): Sends a broadcast push notification to wallet passes (Apple Wallet + Google Wallet). Scope: `notifications:send`. and an `Idempotency-Key` header.
- [Retrieve a notification](https://vexioncards.mintlify.app/api-reference/notifications/retrieve-a-notification.md): Returns the notification object - the **single source of truth** for broadcast state: lifecycle `status` (queued/scheduled/processing/completed/partial/failed/cancelled), aggregate per-channel `stats`, and the lifecycle timestamps (`schedule_at`, `sent_at`, `completed_at`).
- [Cancel a scheduled notification](https://vexioncards.mintlify.app/api-reference/notifications/cancel-a-scheduled-notification.md): Cancels a **scheduled** broadcast (future `schedule_at`) whose fan-out has not started yet. Sets `status: "cancelled"`.
- [List per-recipient deliveries](https://vexioncards.mintlify.app/api-reference/notifications/list-per-recipient-deliveries.md): Returns the per-recipient, per-device delivery rows for one broadcast - the answer to "did customer X receive it, on which device, and why not".

### Locations

- [List locations](https://vexioncards.mintlify.app/api-reference/locations/list-locations.md): Lists your locations, newest first - each row is the **full Location object**: address + pin, geo notification, enabled cards with their per-location signup URLs, assigned team, and POS-bridge status. Organizations have few locations, so no slim row shape exists; one call gives you everything the da…
- [Retrieve a location](https://vexioncards.mintlify.app/api-reference/locations/retrieve-a-location.md): Returns one location - the complete picture in a single call. Scope: `locations:read`.
- [Update a location](https://vexioncards.mintlify.app/api-reference/locations/update-a-location.md): Edits a location. Scope: `locations:write`.

### Team members

- [List team members](https://vexioncards.mintlify.app/api-reference/team-members/list-team-members.md): Lists team members, newest first. Scope: `team_members:read`. **Default excludes terminal states** - filter `status=revoked` (dashboard-revoked) or `status=expired` (auto-expired scanners) explicitly to audit past staff (their records are preserved forever so `Transaction.team_member_id` history sta…
- [Create a team member](https://vexioncards.mintlify.app/api-reference/team-members/create-a-team-member.md): Adds a staff account. Scope: `team_members:write`. Pick the flow with `mode`:
- [Retrieve a team member](https://vexioncards.mintlify.app/api-reference/team-members/retrieve-a-team-member.md): Returns one team member by `tm_` id - including `revoked` members, which the default listing hides (their records are preserved so POS transaction history stays attributable). Scope: `team_members:read`.
- [Update a team member](https://vexioncards.mintlify.app/api-reference/team-members/update-a-team-member.md): Edits an `invited` or `active` member. Scope: `team_members:write`.
- [Resend an invitation](https://vexioncards.mintlify.app/api-reference/team-members/resend-an-invitation.md): Re-sends the invitation email to a member still in `status: "invited"` - the previous accept link is superseded. Use when the first email was lost or the link aged out. Scope: `team_members:write`.

### Custom fields

- [List custom fields](https://vexioncards.mintlify.app/api-reference/custom-fields/list-custom-fields.md): Lists your reusable custom-field definitions, cursor-paginated, with live usage bookkeeping on every row: `usage_count` and `cards_using[]` show exactly which card templates reference each field - the numbers that decide which edits are allowed (renames, type changes, and option removals are blocked…
- [Create a custom field](https://vexioncards.mintlify.app/api-reference/custom-fields/create-a-custom-field.md): Creates a reusable field definition. Scope: `custom_fields:write`.
- [Retrieve a custom field](https://vexioncards.mintlify.app/api-reference/custom-fields/retrieve-a-custom-field.md): Returns one field definition with live usage bookkeeping (`usage_count`, `cards_using[]`). Scope: `custom_fields:read`.
- [Delete a custom field](https://vexioncards.mintlify.app/api-reference/custom-fields/delete-a-custom-field.md): Deletes a field definition - only when nothing references it (`usage_count` must be 0, otherwise `409 custom_field_in_use`; detach it from every card's `form_builder` first). Scope: `custom_fields:write`.
- [Update a custom field](https://vexioncards.mintlify.app/api-reference/custom-fields/update-a-custom-field.md): Lifecycle-gated edit. Scope: `custom_fields:write`. What's allowed depends on whether the field is in use (`usage_count > 0`):

### Events

- [List events](https://vexioncards.mintlify.app/api-reference/events/list-events.md): Account-wide feed of domain events that fanned out to at least one enabled webhook endpoint, newest first. Each row carries the same envelope content a subscribed receiver was pushed - useful for reconciliation, backfilling a receiver that was down, or building your own audit trail without inspectin…

### Webhook endpoints

- [List webhook endpoints](https://vexioncards.mintlify.app/api-reference/webhook-endpoints/list-webhook-endpoints.md): Lists your registered webhook receivers, cursor-paginated (default 25, max 100), newest first. Filter by `status` to find `auto_disabled` endpoints that need attention after sustained failures.
- [Create a webhook endpoint](https://vexioncards.mintlify.app/api-reference/webhook-endpoints/create-a-webhook-endpoint.md): ## Delivery retries
- [List catalog event types](https://vexioncards.mintlify.app/api-reference/webhook-endpoints/list-catalog-event-types.md): Returns the full, fixed catalog of webhook event names your integration can subscribe to (the same 22-name `WebhookEventName` enum accepted by `enabled_events`), each with a one-line description of when it fires. Not paginated - the catalog is small and changes only alongside a versioned API bump, n…
- [Retrieve a webhook endpoint](https://vexioncards.mintlify.app/api-reference/webhook-endpoints/retrieve-a-webhook-endpoint.md): Returns one webhook endpoint: its URL, subscribed events, status, and pinned `api_version` - everything except the `secret`, which only ever appears in create and rotate responses (lost secret = rotate).
- [Delete a webhook endpoint](https://vexioncards.mintlify.app/api-reference/webhook-endpoints/delete-a-webhook-endpoint.md): Deletes the endpoint. In-flight retries are cancelled. Past delivery records stay readable for 90 days via the deliveries listing.
- [Update a webhook endpoint](https://vexioncards.mintlify.app/api-reference/webhook-endpoints/update-a-webhook-endpoint.md): Updates `url`, `description`, `enabled_events`, or `status`. URL changes re-run SSRF validation. `api_version` is **immutable** - create a new endpoint to move to a newer date version.
- [List recent deliveries](https://vexioncards.mintlify.app/api-reference/webhook-endpoints/list-recent-deliveries.md): Returns the last **90 days** of delivery attempts for this endpoint, newest first. One row per attempt including retries - high volume; use `limit=100` to drain faster.
- [Retry (resend) a webhook delivery](https://vexioncards.mintlify.app/api-reference/webhook-endpoints/retry-resend-a-webhook-delivery.md): Manually re-send a past delivery - the manual counterpart to the automatic 12-attempt retry. A new delivery attempt is created for the SAME event: it carries the same `webhook-id` (event id) as the original, so an idempotent receiver de-duplicates it against the first delivery. The original delivery…
- [Rotate the signing secret](https://vexioncards.mintlify.app/api-reference/webhook-endpoints/rotate-the-signing-secret.md): Mints a new signing secret and returns it - the only other place a secret is ever visible. Scope: `webhooks:manage`.
- [Send a test event](https://vexioncards.mintlify.app/api-reference/webhook-endpoints/send-a-test-event.md): Sends a synthetic event to the endpoint **synchronously** and returns the delivery result - wire up your receiver, then prove the whole path (TLS, signature verification, 2xx) in one call before going live.

### API keys

- [Verify the calling key](https://vexioncards.mintlify.app/api-reference/api-keys/verify-the-calling-key.md): The **whoami** endpoint - returns the calling key's own object: scopes, status, and effective rate limits. Never any secret material (`masked_key` only).

### Organization

- [Retrieve your organization](https://vexioncards.mintlify.app/api-reference/organization/retrieve-your-organization.md): **Scope: `organization:read`.** Added 2026-07-27 (owner-approved versioned API change, v1 scope registry reopened from twelve to thirteen scopes) - this endpoint used to require no scope at all, so any valid key for the organization could read it regardless of its granted scopes; that gap is now clo…
- [List invoices](https://vexioncards.mintlify.app/api-reference/organization/list-invoices.md): Returns issued subscription invoices, newest first, cursor-paginated (default 25, max 100).
- [Retrieve an invoice](https://vexioncards.mintlify.app/api-reference/organization/retrieve-an-invoice.md): Returns a single invoice with a **freshly signed** `pdf_url` (1-hour TTL). Download promptly; the url itself expires per S3's own presigned-URL rules - an expired link returns S3's own `403 Forbidden` (an XML body, not the VEXiON JSON error envelope, since the request goes straight to S3 and never r…

### Icons

- [List icons](https://vexioncards.mintlify.app/api-reference/icons/list-icons.md): Browse the VEXiON cards 3D icon library. 10,000+ icons across 23 categories (Animals, Food & Drink, Technology & Media, etc.) for use as stamp_icon_url on stamp cards or pattern_icon_urls[] on non-stamp cards.

### API Reference

- [Webhook event delivery](https://vexioncards.mintlify.app/api-reference/webhook-event-delivery.md): The envelope this API sends for EVERY webhook event, regardless of which event fired it - see the WebhookEventName enum for the full catalog (customer.*, card.*, transaction.*, notification.*, location.updated, team_member.*, webhook_endpoint.delivery_failed, custom_field.*, product.*). One generic…

## Knowledge Base

### Getting Started

- [Welcome to VEXiON cards](https://vexioncards.mintlify.app/knowledge-base/welcome.md): Your loyalty program, your gift cards, and your wallet passes in one platform.
- [Getting started](https://vexioncards.mintlify.app/knowledge-base/getting-started.md): Create your account, then follow the four Launch steps on Home: your business, your card, trying it as a customer and the first use in the scanner.
- [Launch your loyalty card](https://vexioncards.mintlify.app/knowledge-base/launch-your-card.md): The four Launch steps on Home, on a computer and on a phone: business, card, trying the card as a customer, and the first use in the scanner.
- [The Dashboard Explained](https://vexioncards.mintlify.app/knowledge-base/dashboard.md): Your Home screen at a glance: every KPI, chart, and panel, and what each number actually means.
- [Filtering by Location & Time](https://vexioncards.mintlify.app/knowledge-base/filtering-by-location.md): The two filters that scope everything you see: the time period and the location selector. How they work, where they apply, and what an unassigned record means.
- [Your account](https://vexioncards.mintlify.app/knowledge-base/your-account.md): Manage your personal login to VEXiON cards: your name, email, password, phone, and connected accounts.
- [Emails from VEXiON cards](https://vexioncards.mintlify.app/knowledge-base/emails-from-vexion.md): Which tips, summaries and celebrations VEXiON cards emails you and how often they come.
- [FAQ](https://vexioncards.mintlify.app/knowledge-base/faq.md): Frequently asked questions about VEXiON cards.

### Cards

- [Overview](https://vexioncards.mintlify.app/knowledge-base/card-types.md): The card types you can create, what each one does, and which is the right fit for your business.
- [Creating a Card](https://vexioncards.mintlify.app/knowledge-base/creating-a-card.md): How card creation works, and where to find the step-by-step guide for each card type.
- [The sign-up form](https://vexioncards.mintlify.app/knowledge-base/signup-form.md): Choose what customers fill in to get a card: the built-in fields, your custom questions, and which are required.
- [The customer's wallet pass](https://vexioncards.mintlify.app/knowledge-base/wallet-pass.md): What a customer actually sees: the card in Apple Wallet or Google Wallet, and the notifications they receive.

#### Card Types

- [Stamp Card](https://vexioncards.mintlify.app/knowledge-base/stamp-card.md): Create a collect-and-earn stamp card step by step: customers gather stamps and unlock a reward when the card is full.
- [Reward Card](https://vexioncards.mintlify.app/knowledge-base/reward-card.md): Create a points-based reward card step by step: customers earn points and redeem them for rewards you choose.
- [Cashback card](https://vexioncards.mintlify.app/knowledge-base/cashback-card.md): Create a cashback card step by step: customers earn a percentage back as credit in your currency, with one rate or levels by total spend.
- [Discount Card](https://vexioncards.mintlify.app/knowledge-base/discount-card.md): Create a discount card step by step: an automatic percentage discount that can grow with spending.
- [Coupon](https://vexioncards.mintlify.app/knowledge-base/coupon-card.md): Create a single-use coupon step by step: a one-off offer for promotions, welcome deals, and win-back campaigns.
- [Gift Card](https://vexioncards.mintlify.app/knowledge-base/gift-card.md): Create a prepaid gift card step by step: sell stored value in store or online.
- [Membership Card](https://vexioncards.mintlify.app/knowledge-base/membership-card.md): Create a time-limited membership step by step: sell plans with validity schedules and daily entry limits.
- [Employee Card](https://vexioncards.mintlify.app/knowledge-base/employee-card.md): Create a staff card: a discount in % that starts at a spend amount, with an optional monthly limit. Start from a template.

#### Card options

- [Starting bonus](https://vexioncards.mintlify.app/knowledge-base/starting-bonus.md): Give new customers a head start with points, stamps or credit the moment they sign up for a card.
- [Refer a friend](https://vexioncards.mintlify.app/knowledge-base/refer-a-friend.md): Reward your customers for bringing in new ones, with a bonus for the referrer and a bonus for the friend who joins.
- [Level retention](https://vexioncards.mintlify.app/knowledge-base/level-retention.md): Customers who stop coming drop one level. Switch it on for discount cards and cashback cards with levels, set the days, and see what your customers get.
- [Card issuance limit](https://vexioncards.mintlify.app/knowledge-base/card-issuance-limit.md): Cap how many of a card can be issued, for limited runs, founding-member offers, or capacity-limited programs.
- [Review link](https://vexioncards.mintlify.app/knowledge-base/google-review.md): Put a review link on your customers' cards, pointing at the store they actually visited.

### Managing Existing Cards

- [The Passes Page](https://vexioncards.mintlify.app/knowledge-base/passes-page.md): Where all your cards live: find, open, share, and manage every card from one place.
- [Sharing & Enrolling Customers](https://vexioncards.mintlify.app/knowledge-base/sharing-a-card.md): Get customers onto a card with its link, QR code, poster, Instagram story or stickers. One window, ready-made files in your card's colours.
- [How customers join](https://vexioncards.mintlify.app/knowledge-base/customer-signup.md): What your customers see when they sign up for a card and add it to Apple Wallet or Google Wallet.
- [Editing a Card](https://vexioncards.mintlify.app/knowledge-base/editing-a-card.md): Change a card's settings, design, and details any time through the tabbed editor, and rename, duplicate, or delete it.
- [Card Activity & Customers](https://vexioncards.mintlify.app/knowledge-base/card-activity-customers.md): See every transaction on a card and everyone who holds it, from the card's Activity and Customers tabs.
- [Card Analytics](https://vexioncards.mintlify.app/knowledge-base/card-analytics.md): The Analytics tab on each card, and how the panels differ by card type.
- [Sending a Push to a Card](https://vexioncards.mintlify.app/knowledge-base/sending-a-push.md): Send a push notification to everyone who holds a card, straight to their wallet pass.
- [Physical Gift Cards](https://vexioncards.mintlify.app/knowledge-base/physical-gift-cards.md): Generate, print, and sell pre-printed physical gift cards that customers scan to load a balance into their wallet.

#### Analytics by card type

- [Stamp Analytics](https://vexioncards.mintlify.app/knowledge-base/analytics-stamp.md): The Analytics tab for stamp cards, also with Paid in advance: completion, drop-off, and timing.
- [Reward & Cashback Analytics](https://vexioncards.mintlify.app/knowledge-base/analytics-reward.md): The Analytics tab for reward and cashback cards: points, cashback, and distribution.
- [Discount Analytics](https://vexioncards.mintlify.app/knowledge-base/analytics-discount.md): The Analytics tab for discount and employee cards: tiers, savings, and ROI.
- [Gift Card Analytics](https://vexioncards.mintlify.app/knowledge-base/analytics-gift.md): The Analytics tab for gift cards: balances, redemption, expiration, and ROI.
- [Coupon Analytics](https://vexioncards.mintlify.app/knowledge-base/analytics-coupon.md): The Analytics tab for coupons: redemption, timing, and impact.
- [Membership Analytics](https://vexioncards.mintlify.app/knowledge-base/analytics-membership.md): Detailed analytics for membership cards are coming soon.

### Customers

- [The Customers Page](https://vexioncards.mintlify.app/knowledge-base/customers-page.md): Find and manage everyone enrolled across all your cards from one list.
- [The Customer Profile](https://vexioncards.mintlify.app/knowledge-base/customer-profile.md): Everything about one customer: their stats, transactions, notifications, and details.
- [The profile your customers see](https://vexioncards.mintlify.app/knowledge-base/customer-wallet-profile.md): Every card holder has their own profile page, opened from the card in their wallet: their balance, rewards, history, details and messages.
- [Adding a Customer](https://vexioncards.mintlify.app/knowledge-base/adding-a-customer.md): Issue a card to someone yourself and send it to them, from the dashboard or the scanner.

### Scanner

- [Using the Scanner](https://vexioncards.mintlify.app/knowledge-base/using-the-scanner.md): The screen your staff use all day: scan a card, then add stamps, points, a discount, or a top-up.

#### Actions by card type

- [Stamp cards on the scanner](https://vexioncards.mintlify.app/knowledge-base/scanner-stamp.md): Add stamps as customers buy, and redeem their reward.
- [Stamp cards paid in advance on the scanner](https://vexioncards.mintlify.app/knowledge-base/scanner-prepaid-stamp.md): Deduct prepaid stamps as the customer uses them, and recharge the card.
- [Product reward cards on the scanner](https://vexioncards.mintlify.app/knowledge-base/scanner-reward.md): Add points from purchases, and redeem them for the rewards you defined.
- [Cashback cards on the scanner](https://vexioncards.mintlify.app/knowledge-base/scanner-cashback.md): Add a purchase to earn credit, and redeem credit as money off.
- [Discount cards on the scanner](https://vexioncards.mintlify.app/knowledge-base/scanner-discount.md): Apply a customer's discount to their purchase, and record the spend.
- [Coupon cards on the scanner](https://vexioncards.mintlify.app/knowledge-base/scanner-coupon.md): Redeem a single-use coupon in one tap.
- [Gift cards on the scanner](https://vexioncards.mintlify.app/knowledge-base/scanner-gift.md): Top up a gift card balance or deduct a payment at the till.
- [Membership cards on the scanner](https://vexioncards.mintlify.app/knowledge-base/scanner-membership.md): Activate or renew a membership, and check members in.
- [Employee cards on the scanner](https://vexioncards.mintlify.app/knowledge-base/scanner-employee-discount.md): Apply a staff discount, with or without a monthly limit.

### Notifications

- [Notifications](https://vexioncards.mintlify.app/knowledge-base/notifications.md): Send a message straight to your customers' phones, on demand or automatically.
- [Sending a notification](https://vexioncards.mintlify.app/knowledge-base/sending-a-notification.md): Compose a one-off push, personalise it, and send it now or on a schedule.
- [Automatic notifications](https://vexioncards.mintlify.app/knowledge-base/notification-automations.md): Messages that send themselves at the right moment: reviews, win-backs, birthdays, and name days.
- [Automatic messages](https://vexioncards.mintlify.app/knowledge-base/automatic-messages.md): Every message VEXiON cards sends to a customer on its own after a scan, a redemption, or a reversal, by card type.
- [Delivery & history](https://vexioncards.mintlify.app/knowledge-base/notification-delivery.md): Where notifications go, how to read the delivery stats, and the full history of what you sent.

### Settings

- [Settings](https://vexioncards.mintlify.app/knowledge-base/settings-overview.md): Where you manage your business: general preferences, team, locations, billing, and more.
- [General settings](https://vexioncards.mintlify.app/knowledge-base/general-settings.md): Your business name, currency, language, scanner mode, and privacy preferences.
- [Team & roles](https://vexioncards.mintlify.app/knowledge-base/team-and-roles.md): Invite staff, choose what they can do, and assign them to locations.
- [Locations](https://vexioncards.mintlify.app/knowledge-base/locations.md): Your stores or branches: geo-notifications, which cards they run, sign-up links, staff, and billing.
- [Custom fields](https://vexioncards.mintlify.app/knowledge-base/custom-fields.md): Add your own questions to the sign-up form and reuse them across your cards.
- [Integrations](https://vexioncards.mintlify.app/knowledge-base/integrations.md): Connect VEXiON cards to your POS or e-commerce platform so loyalty runs automatically.
- [Danger zone](https://vexioncards.mintlify.app/knowledge-base/danger-zone.md): Your wallet certificate, exporting your data, and deleting your account.

#### Developer

- [API keys](https://vexioncards.mintlify.app/knowledge-base/developer-api-keys.md): Create keys to connect your own tools to the VEXiON cards API, and control exactly what each one can do.
- [Webhooks](https://vexioncards.mintlify.app/knowledge-base/developer-webhooks.md): Get a signed message at your own URL the moment something happens, no polling required.
- [AI assistants (MCP)](https://vexioncards.mintlify.app/knowledge-base/developer-ai-assistants.md): Connect Claude, ChatGPT or another AI assistant to your VEXiON business, choose what it may do, and remove it at any time.
- [AI assistants: safety and questions](https://vexioncards.mintlify.app/knowledge-base/developer-ai-assistants-safety.md): What a connected AI assistant can and cannot do in your VEXiON business, why messages to customers need your confirmation, and what to do when something does not work.

#### Billing

- [Plans & pricing](https://vexioncards.mintlify.app/knowledge-base/billing-plans.md): VEXiON cards ONE and PRO, what each includes, and how to subscribe, upgrade, or switch to annual.
- [Per-location pricing](https://vexioncards.mintlify.app/knowledge-base/billing-locations.md): How VEXiON cards PRO prices each store on a graduated scale, and how to add or remove locations.
- [Delegated billing](https://vexioncards.mintlify.app/knowledge-base/billing-delegated.md): Let a manager pay for and run their own location, the franchise model.
- [Pausing your account](https://vexioncards.mintlify.app/knowledge-base/billing-pausing.md): Take a break from paying without losing your cards, customers, or data.
- [Cancelling your subscription](https://vexioncards.mintlify.app/knowledge-base/billing-cancelling.md): How to cancel, the retention offer, and what happens to your account afterwards.
- [Invoices & billing details](https://vexioncards.mintlify.app/knowledge-base/billing-invoices.md): Download your invoices, set the invoice email, and check the legal details on them.
- [Refer a business](https://vexioncards.mintlify.app/knowledge-base/refer-a-business.md): Give another business a 49 EUR gift and earn up to a year of VEXiON free for the businesses that join with your link and pay.

### Integrations

- [Integrations](https://vexioncards.mintlify.app/knowledge-base/integrations.md): Connect VEXiON cards to your POS or e-commerce platform so loyalty runs automatically.

#### POS systems

##### Dotykačka

- [Dotykačka: overview](https://vexioncards.mintlify.app/knowledge-base/dotykacka-overview.md): Connect VEXiON cards to your Dotykačka POS so loyalty cards are handled automatically at the till.
- [Dotykačka: connecting & setup](https://vexioncards.mintlify.app/knowledge-base/dotykacka-setup.md): Connect VEXiON cards to your Dotykačka POS and configure the integration, step by step.
- [Dotykačka: multi-cloud (multiple locations)](https://vexioncards.mintlify.app/knowledge-base/dotykacka-multicloud.md): Run one loyalty program across several Dotykačka clouds under a single VEXiON account.
- [Dotykačka: card types & point setup](https://vexioncards.mintlify.app/knowledge-base/dotykacka-card-types.md): Set up each card type and configure points directly in Dotykačka.
- [Dotykačka: working at the till](https://vexioncards.mintlify.app/knowledge-base/dotykacka-pos.md): A guide for cashiers on using VEXiON cards day to day in the Dotykačka POS.

##### Storyous

- [Storyous: overview](https://vexioncards.mintlify.app/knowledge-base/storyous-overview.md): Connect VEXiON cards to your Storyous POS so loyalty cards are handled automatically at the till.
- [Storyous: connecting & setup](https://vexioncards.mintlify.app/knowledge-base/storyous-setup.md): Connect VEXiON cards to your Storyous POS, map your locations, and choose your loyalty settings.
- [Storyous: menu & products](https://vexioncards.mintlify.app/knowledge-base/storyous-menu.md): Sync your Storyous menu into VEXiON and set which products earn and redeem loyalty points.
- [Storyous: card types & point setup](https://vexioncards.mintlify.app/knowledge-base/storyous-card-types.md): Set up each card type for Storyous and configure points on your products in VEXiON.
- [Storyous: working at the till](https://vexioncards.mintlify.app/knowledge-base/storyous-pos.md): A guide for cashiers on using VEXiON cards day to day in the Storyous POS.

##### Papaya

- [Papaya: overview](https://vexioncards.mintlify.app/knowledge-base/papaya-overview.md): Connect VEXiON cards to your Papaya POS so loyalty cards are handled at the till.
- [Papaya: connecting & setup](https://vexioncards.mintlify.app/knowledge-base/papaya-setup.md): Connect VEXiON cards to your Papaya POS with the 3-step setup wizard.
- [Papaya: menu & products](https://vexioncards.mintlify.app/knowledge-base/papaya-menu.md): Sync your Papaya menu into VEXiON and set which products earn and redeem loyalty points.
- [Papaya: card types & point setup](https://vexioncards.mintlify.app/knowledge-base/papaya-card-types.md): Set up each card type for Papaya, and choose automatic or manual redemption.
- [Papaya: gift cards](https://vexioncards.mintlify.app/knowledge-base/papaya-gift-cards.md): Sell, top up and spend VEXiON gift cards at the Papaya till, and complete online orders that the customer pays at the counter.
- [Papaya: working at the till](https://vexioncards.mintlify.app/knowledge-base/papaya-pos.md): A short guide for cashiers on using VEXiON cards in the Papaya POS.

##### Oberon

- [OBERON: overview](https://vexioncards.mintlify.app/knowledge-base/oberon-overview.md): Connect VEXiON cards to your OBERON POS so loyalty cards are handled at the till.
- [OBERON: connecting & setup](https://vexioncards.mintlify.app/knowledge-base/oberon-setup.md): Connect your OBERON tills to VEXiON cards with an address, a username and a password.
- [OBERON: card types & settings](https://vexioncards.mintlify.app/knowledge-base/oberon-card-types.md): Which VEXiON card types work with OBERON, and how points and discounts are calculated.
- [OBERON: working at the till](https://vexioncards.mintlify.app/knowledge-base/oberon-pos.md): What the cashier does in OBERON to load a VEXiON card, apply a benefit and finish the sale.

#### Reservations

- [Bookio](https://vexioncards.mintlify.app/knowledge-base/bookio.md): Connect your Bookio booking system so customers' upcoming appointments show on their loyalty card.

#### E-commerce

##### Shopify

- [Shopify: overview](https://vexioncards.mintlify.app/knowledge-base/shopify-overview.md): Run your VEXiON cards loyalty program on your Shopify store, so customers earn and redeem online with the same cards they use in store.
- [Shopify: connecting your store](https://vexioncards.mintlify.app/knowledge-base/shopify-setup.md): Connect your Shopify store to VEXiON cards from Settings, and manage the connection.
- [Shopify: configuring loyalty](https://vexioncards.mintlify.app/knowledge-base/shopify-configuration.md): Choose which loyalty mechanics run on your Shopify store, and add the loyalty widgets to your storefront.
- [Shopify: what your customers see](https://vexioncards.mintlify.app/knowledge-base/shopify-customer-experience.md): The shopper's journey on your Shopify store: joining, earning points, and redeeming rewards in the cart.

#### Payments

- [Stripe Connect](https://vexioncards.mintlify.app/knowledge-base/stripe-connect.md): Sell gift cards online, with Stripe handling the payment and the money going straight to your account.

## OpenAPI Specs

- [openapi](/openapi.json)

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [Czech (172 pages)](https://vexioncards.mintlify.app/_llms/cs.txt): Documentation for Czech.
- [Czech / Centrum pomoci (102 pages)](https://vexioncards.mintlify.app/_llms/cs/centrum-pomoci.txt): Documentation for Czech / Centrum pomoci.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.