# BrandWallet

- [Digital Loyalty Platform for Modern Businesses](https://docs.brand-wallet.com/introduction-2.md): BrandWallet is a complete digital loyalty solution — build stamp cards, point programs, and tiered rewards without writing a single line of code.
- [BrandWallet Quickstart: Launch Your Loyalty Program](https://docs.brand-wallet.com/quickstart.md): Create your BrandWallet account, design your first loyalty campaign, and start rewarding customers — the entire setup takes about 10 minutes.
- [BrandWallet Pricing Plans — Basic, Standard, and Growth](https://docs.brand-wallet.com/pricing.md): Compare BrandWallet's Basic, Standard, and Growth plans. Pricing starts at $50/month, and annual billing saves up to 20% versus monthly rates.
- [BrandWallet Loyalty Campaign Types and Plan Limits](https://docs.brand-wallet.com/loyalty/campaign-types.md): BrandWallet supports seven loyalty campaign types — stamp cards, point cards, discount cards, event cards, staff cards, tiered cards, and membership cards.
- [Design and Customize Your Loyalty Cards with BrandWallet](https://docs.brand-wallet.com/loyalty/campaign-designer.md): Use BrandWallet's Campaign & Pass Designer to build branded digital loyalty cards — customize colors, logos, layouts, and messages from the dashboard.
- [Add-On Promotions: Boost Loyalty Campaign Engagement](https://docs.brand-wallet.com/loyalty/add-on-promotions.md): Add-on promotions layer extra rewards on your BrandWallet campaigns — double points, time-limited bonuses, referral rewards, and exclusive discounts.
- [BrandWallet Merchant App: Manage Loyalty On the Go](https://docs.brand-wallet.com/merchant-app/overview.md): The BrandWallet Merchant App for iOS and Android lets you manage campaigns, view real-time analytics, send push notifications, and reach customers.
- [Manage Team Access and Roles in BrandWallet Merchant App](https://docs.brand-wallet.com/merchant-app/team-management.md): Invite staff to manage your BrandWallet account with role-based access — assign Admin, Manager, Staff, or Viewer roles to control what each user can do.
- [Send Push Notifications to Customers via BrandWallet](https://docs.brand-wallet.com/merchant-app/push-notifications.md): BrandWallet lets you send transactional, marketing, and location-based push notifications — customize content, timing, and targeting from the dashboard.
- [Analytics and Reporting in the BrandWallet Dashboard](https://docs.brand-wallet.com/merchant-app/reporting.md): Track campaign performance, customer behavior, and loyalty program health with BrandWallet's real-time dashboard. Export data as CSV, Excel, PDF, or JSON.
- [Getting Started with BrandWallet — Quick Setup FAQ](https://docs.brand-wallet.com/faq/getting-started.md): Common questions about setting up BrandWallet for the first time — account creation, setup time, technical requirements, and browser support.
- [BrandWallet Campaign Designer: Cards, Design & Rewards FAQ](https://docs.brand-wallet.com/faq/campaign-designer.md): BrandWallet Campaign Designer FAQ — card types, design customization, multilingual support, personalized offers, and tiered rewards explained.
- [Push Notifications and Communication FAQ — BrandWallet](https://docs.brand-wallet.com/faq/communication.md): BrandWallet push notifications FAQ — birthday messages, geo-targeting, notification customization, and personalized customer engagement campaigns.
- [BrandWallet Reporting FAQ: Analytics, Exports and Data](https://docs.brand-wallet.com/faq/reporting.md): Frequently asked questions about BrandWallet reporting — analytics tools, data export formats, data ownership, privacy, and key performance metrics.
- [BrandWallet Legal: Privacy, GDPR, CCPA, and PIPEDA FAQ](https://docs.brand-wallet.com/faq/legal.md): BrandWallet's compliance with GDPR, CCPA, and PIPEDA — data protection measures, customer data rights, privacy policy, and terms of service summary.
- [BrandWallet Support: Help, Training, and Contact Info](https://docs.brand-wallet.com/faq/support.md): BrandWallet support options — email, phone, live chat, training sessions, and help desk. Response times vary by subscription plan.
- [Headless Loyalty System](https://docs.brand-wallet.com/integrations/introduction.md): BrandWallet provides complete set of tools for you to integrate loyalty capabilities to your systems or apps.
- [Start integrating with BrandWallet ](https://docs.brand-wallet.com/integrations/quickstart.md)
- [Authentication](https://docs.brand-wallet.com/integrations/authentication.md)
- [Sync Data](https://docs.brand-wallet.com/integrations/sync-data.md): Synchronize critical resources to BrandWallet
- [Your First Transaction](https://docs.brand-wallet.com/process/first-transaction.md): Learn how to find a subscriber, load all of their data and send a transaction to be processes by BrandWallet.
- [Find the Subscriber](https://docs.brand-wallet.com/process/find-subscriber.md)
- [Process Transaction](https://docs.brand-wallet.com/process/process-transaction.md)
- [Get Customer Coupons](https://docs.brand-wallet.com/process/get-coupons.md)
- [Redeem a Coupon](https://docs.brand-wallet.com/process/redeem-coupon.md)
- [Standard Payload](https://docs.brand-wallet.com/untitled-page-8.md)
- [Errors](https://docs.brand-wallet.com/untitled-page-9.md)
- [How to use BrandWallet API](https://docs.brand-wallet.com/api/overview.md): BrandWallet's REST API lets your system look up customers, list and redeem coupons, and process transactions with loyalty campaigns and rewards.
- [Authentication](https://docs.brand-wallet.com/api/authentication.md): Exchange your API key and API secret for an organization-scoped Bearer token, and keep it fresh with rotating refresh tokens.
- [Pagination & Filtering](https://docs.brand-wallet.com/api/pagination.md): Learn how BrandWallet list endpoints return paged results and how to filter the results with a filter query.
- [The Customer Object](https://docs.brand-wallet.com/api/customer-object.md): The shape of a BrandWallet customer record as returned by the customer endpoints.
- [Create a customer](https://docs.brand-wallet.com/api/create-customer.md): Create a bare BrandWallet customer without enrolling them into a campaign.
- [Register a customer](https://docs.brand-wallet.com/api/register-customer.md): Register a new or existing BrandWallet customer into a campaign, creating their wallet card and loyalty balances.
- [List all customers](https://docs.brand-wallet.com/api/list-customers.md): Returns paginated customers for the organization your access token is scoped to, with optional filters on email, phone, status, and opaqueId.
- [Find a customer](https://docs.brand-wallet.com/api/find-customer.md): Resolve a single BrandWallet customer by id, phone, email, or card barcode. Returns loyalty balances, wallet cards with their campaign configuration, and active coupons in one call.
- [Update a customer](https://docs.brand-wallet.com/api/update-customer.md): Update a BrandWallet customer's profile, metadata, consents, or external id.
- [Delete a customer](https://docs.brand-wallet.com/api/delete-customer.md): Soft-delete a BrandWallet customer and disable their active coupons.
- [Void & activate a customer](https://docs.brand-wallet.com/api/void-customer.md): Block a BrandWallet customer from transactions, or lift the block.
- [List coupons](https://docs.brand-wallet.com/api/list-coupons.md): Return the coupons belonging to a BrandWallet customer, optionally filtered to a single wallet card.
- [Redeem a coupon](https://docs.brand-wallet.com/api/redeem-coupon.md): Mark a BrandWallet coupon as redeemed and return the updated coupon.
- [The User Object](https://docs.brand-wallet.com/api/user-object.md): The shape of a BrandWallet user record as returned by the user endpoints.
- [List all users](https://docs.brand-wallet.com/api/list-users.md): Returns paginated users for the organization your access token is scoped to, with optional filters on email, phone, status, role, and branch.
- [Get a user](https://docs.brand-wallet.com/api/get-user.md): Returns a single user of the organization your access token is scoped to, by id.
- [Create a user](https://docs.brand-wallet.com/api/create-user.md): Create a branch-level user (cashier or branch manager) in the organization your access token is scoped to.
- [Update a user](https://docs.brand-wallet.com/api/update-user.md): Update a branch-level user's profile, status, branches, or roles.
- [Delete a user](https://docs.brand-wallet.com/api/delete-user.md): Soft-delete a branch-level user of the organization your access token is scoped to.
- [The Transaction Object](https://docs.brand-wallet.com/api/transaction-object.md): The shape of a BrandWallet transaction: the basket you submit and the executed loyalty actions you get back.
- [Process a transaction](https://docs.brand-wallet.com/api/process-transaction.md): Commit a basket transaction for a BrandWallet customer's card: run campaigns, redeem coupons, and deduct spent points in a single call.
- [Validate a transaction](https://docs.brand-wallet.com/api/validate-transaction.md): Dry-run a BrandWallet transaction: preview exactly what process would do — campaign results, rewards, promotions, milestones, and the amount to charge — without committing anything.
- [List all transactions](https://docs.brand-wallet.com/api/list-transactions.md): Returns paginated transactions for the organization your access token is scoped to, with optional filters on customer, campaign, category, orderId, and rollback state.
- [Retrieve a transaction](https://docs.brand-wallet.com/api/get-transaction.md): Returns a single transaction's summary record — check its rollback state before undoing it.
- [Roll back a transaction](https://docs.brand-wallet.com/api/rollback-transaction.md): Undo a committed transaction: collected stamps/points are restored, granted reward coupons are cancelled, and a redeemed coupon becomes active again.
- [Create a product](https://docs.brand-wallet.com/api/create-product.md): Add a product to your BrandWallet menu. Products power product-filtered campaigns and menu synchronization.
- [List all products](https://docs.brand-wallet.com/api/list-products.md): Returns paginated products for the organization your access token is scoped to, with optional filters on status, sku, barcode, opaqueId, categories, and price.
- [Get a product](https://docs.brand-wallet.com/api/get-product.md): Retrieve a single BrandWallet product by id.
- [Update a product](https://docs.brand-wallet.com/api/update-product.md): Update the fields of an existing BrandWallet product. Only the fields you send are changed.
- [Delete a product](https://docs.brand-wallet.com/api/delete-product.md): Soft-delete a BrandWallet product. The record is kept but permanently drops out of list and get results.
- [Create a category](https://docs.brand-wallet.com/api/create-category.md): Add a product category to your BrandWallet menu. Categories power category-filtered campaigns and menu synchronization.
- [List all categories](https://docs.brand-wallet.com/api/list-categories.md): Returns paginated product categories for the organization your access token is scoped to, with optional filters on status, opaqueId, and parent.
- [Get a category](https://docs.brand-wallet.com/api/get-category.md): Retrieve a single BrandWallet product category by id.
- [Update a category](https://docs.brand-wallet.com/api/update-category.md): Update the fields of an existing BrandWallet product category. Only the fields you send are changed.
- [Delete a category](https://docs.brand-wallet.com/api/delete-category.md): Soft-delete a BrandWallet product category. The record is kept but permanently drops out of list and get results.
- [Transaction Payload](https://docs.brand-wallet.com/api/standard-payload.md): Construct a single JSON payload for BrandWallet transactions: campaigns, coupon redemptions, and point spend in one call.
- [Errors](https://docs.brand-wallet.com/api/errors.md): Every BrandWallet API error returns a JSON envelope with a stable machine-readable token in the message field. Reference all error codes here.


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