For AI agents: visit https://hub.wallet.dev/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Home Guides API Reference Changelog

API Reference

Jump to Content

Home Guides API Reference Changelog

Welcome! (Start Here)

API Reference: Overview
Creating an API Key
Using Postman

APPLY BRANDING

QR Code Designs
Payment Designs

ATTRACT VISITORS

Amenities
Dining
Gaming
Gallery
Quick Links
Quick Links Section
Lounge
Short Links
News
Performances
Products
Room Rates
Services
Videos
Virtual Business Card

ENGAGE SUBSCRIBERS

Apple Wallet Subscribers
- Get all subscribersget
- Get subscriber activityget
App-to-Person (A2P) Registration
Email Subscribers
SMS Operations
SMS Subscribers

MOTIVATE CUSTOMERS

Promotion Codes
Prizes
Dynamic Vouchers
Merchant Credits
Static Voucher Campaigns
Static Vouchers
Tickets

REWARD MEMBERS

Club Members
Membership Tiers

CONNECT INTEGRATIONS

InfoGenesis Reports
Wallet Transaction Ledger
- Get ledger entriesget
Point-of-Sale Configuration
Wallet Mobile Terminal
Shopify Terminal
Wallet Web Terminal
Wix Terminal
WooCommerce Terminal

REVIEW ANALYTICS

Analytics
Dashboard Summaries

CHANGE SETTINGS

Billing & Payments
Employees
Merchant
System
Countries
- Get all Countries with ISO abbreviations & Telephone country code prefixesget
Industries
- Get all Industries & Pricing Plansget
- Get all Industries & Pricing Plans with trimmed metadataget

WALLET UI

Customer
Wallet Configuration
- Update wallet recordput
- Update payment design for merchant creditsput
Interactions

WEBHOOKS

Visitors.Authentiation.success
Visitors.CalendarEvent.downloaded
- Visitors.CalendarEvent.downloadedwebhook
Visitors.BusinessCard.downloaded
- Visitors.BusinessCard.downloadedwebhook
Subscribers.Email.opt_in
- Subscribers.Email.opt_inwebhook
Subscribers.SMS.default_opt_in
- Subscribers.SMS.default_opt_inwebhook
Subscribers.SMS.keyword_opt_in
- Subscribers.SMS.keyword_opt_inwebhook
Customers.StaticVoucher.redeemed
- Customers.StaticVoucher.redeemedwebhook
Customers.StaticVoucher.refunded
- Customers.StaticVoucher.refundedwebhook
Customers.Prize.redeemed
- Customers.Prize.redeemedwebhook
Customers.Prize.refunded
- Customers.Prize.refundedwebhook
Customers.DynamicVoucher.redeemed
- Customers.DynamicVoucher.redeemedwebhook
Customers.DynamicVoucher.refunded
- Customers.DynamicVoucher.refundedwebhook
Customers.MerchantCredit.redeemed
- Customers.MerchantCredit.redeemedwebhook
Customers.MerchantCredit.refunded
- Customers.MerchantCredit.refundedwebhook
Customers.Ticket.redeemed
- Customers.Ticket.redeemedwebhook
Customers.Ticket.claimed
- Customers.Ticket.claimedwebhook
Customers.Ticket.unclaimed
- Customers.Ticket.unclaimedwebhook
Members.Points.redeemed
- Members.Points.redeemedwebhook
Members.Points.refunded
- Members.Points.refundedwebhook
Members.Tier.redeemed
- Members.Tier.redeemedwebhook
Members.Tier.refunded
- Members.Tier.refundedwebhook
WalletPlatform.LedgerEntry.created
- WalletPlatform.LedgerEntry.createdwebhook
WalletPlatform.Invoice.created
- WalletPlatform.Invoice.createdwebhook
WalletPlatform.Invoice.paid
- WalletPlatform.Invoice.paidwebhook
WalletPlatform.Subscription.changed
- WalletPlatform.Subscription.changedwebhook
WalletPlatform.AddOn.purchased
- WalletPlatform.AddOn.purchasedwebhook
WalletPlatform.PaymentMethod.added
- WalletPlatform.PaymentMethod.addedwebhook

wallet-api

App-to-Person (A2P) Registration
Billing & Payments
Stripe Connect
Customer
- Resolve a chat identity to its customer Resolves an opaque chatUserID (a CustomerChatIdentity id) to the same customer payload that POST /v2/customer/search/phoneNumber returns, scoped to the operator's own merchant. The guest phone number is resolved server-side and never travels to the chat processor.get
Employees
- Sets the employee's admin-portal chrome theme (light/dark), synced across devices (KAN-846)put
- Turns the admin-portal page tips bar on or off for this employee, synced across devices (KAN-963)put
SMS Messages
- Estimate SMS/MMS segments for a messagepost
- Get the merchant's outbound-SMS send-freeze status (KAN-440).get
Short Links
- Get Short Link traffic (paginated)get
Orders
Performances
- Ticket reach funnel across all of the merchant's performances Merchant-wide ticket lifecycle funnel (Issued -> Claimed -> Redeemed) with seats and comp/paid splits, for the Dashboard Customer tab and the View Analytics > Customers > Tickets page. Cohort is keyed on issue date: the optional startDate/endDate filter tickets by when they were issued (createdAt), and the later stages count how far those tickets got, regardless of when.get
- Ticket reach funnel for a single performance Per-performance ticket lifecycle funnel (Issued -> Claimed -> Redeemed) with seats and comp/paid splits, for the /tickets "Show Analytics" slide-open. Optional startDate/endDate key the cohort on issue date (createdAt); omit them for the performance's all-time funnel.get
Videos
- Provision a direct video uploadpost
Google Wallet Subscribers
- Get all subscribersget
- Get subscriber activity Scoped to the caller's merchant: the subscription must belong to them (tightening the Apple sibling, which does not re-check ownership on this route).get
OpenAI
Prizes
Gift Cards
Wallet Configuration
Interactions
Industries
- Get the free-by-default (Visitor tier) planget
Visitors.Authentication.success
- Visitors.Authentication.successwebhook

Powered by

Dashboard Summaries

Updated 11 months ago

Refund transaction

Billing & Payments

Did this page help you?

Updated 11 months ago

Refund transaction

Billing & Payments

Did this page help you?