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
Analytics
JUMP TO
Welcome! (Start Here)
API Reference: Overview
Creating an API Key
Using Postman
APPLY BRANDING
QR Code Designs
Get all QR Code Designs
get
Get QR Code Design
get
Update QR Code Design
put
Archive QR Code Design
del
Restore QR Code Design
patch
Create QR Code design
post
Payment Designs
Get all payment designs
get
Get payment design
get
Update payment design
put
Archive payment design
del
Restore payment design
patch
Create payment design
post
ATTRACT VISITORS
Amenities
Get all Amenities
get
Create Amenity
post
Update Amenity
put
Archive Amenity
del
Restore Amenity
patch
Dining
Get all Dining info
get
Create Dining info
post
Update Dining info
put
Archive Dining info
del
Restore Dining info
patch
Gaming
Get all Gaming details
get
Create Gaming info
post
Update Gaming info
put
Archive Gaming info
del
Restore Gaming info
patch
Gallery
Get all Gallery Images
get
Create Gallery Image
post
Update Gallery Image
put
Archive Gallery Image
del
Restore Gallery Image
patch
Quick Links
Get all Quick Links
get
Get Quick Link
get
Update Quick Link
put
Archive Quick Link
del
Restore Quick Link
patch
Create Quick Link
post
Quick Links Section
Get all quick link sections
get
Create quick link section
post
Update quick link section
put
Archive quick link section
del
Restore quick link section
patch
Lounge
Get all Lounges
get
Create Lounge
post
Update Lounge
put
Archive Lounge
del
Restore Lounge
patch
Short Links
Get all Short Links
get
Get Short Link
get
Update Short Link
put
Archive Short Link
del
Restore Short Link
patch
Create Short Link
post
Get Short Link traffic
get
News
Get all News & Blog posts
get
Create News & Blog post
post
Update News & Blog post
put
Archive News & Blog post
del
Restore News & Blog post
patch
Performances
Get all Performances
get
Get Performance
get
Update Performance
put
Archive Performance
del
Restore Performance
patch
Update performance's Ticket Settings
post
Create performance
post
Import Performance's Tickets
post
Export Performance's Tickets
post
Count Performance's claimed Tickets
get
Count Performance's redeemed Tickets
get
Get Performance's Tickets
get
Get Performance's Tickets
get
Products
Get all Products
get
Create Product
post
Update Product
put
Archive Product
del
Restore Product
patch
Room Rates
Get all Rooms & Rates
get
Create Room & Rate
post
Update Room & Rate
put
Archive Room & Rate
del
Restore Room & Rate
patch
Services
Get all Services
get
Create Service
post
Update Service
put
Archive Service
del
Restore Service
patch
Videos
Get all Videos
get
Create Video
post
Update Video
put
Archive Video
del
Restore Video
patch
Virtual Business Card
Get all Virtual Business Cards
get
Get Virtual Business Card
get
Update Virtual Business Card
put
Archive Virtual Business Card
del
Restore Virtual Business Card
patch
Create Virtual Business Card
post
Get Virtual Business Card traffic
get
ENGAGE SUBSCRIBERS
Apple Wallet Subscribers
Get all subscribers
get
Get subscriber activity
get
App-to-Person (A2P) Registration
Get A2P Application
get
Create A2P Application
post
Get A2P Registration
get
Update A2P Application
put
Email Subscribers
Get all Email Subscribers
get
Create Email Subscriber
post
Update Email Subscriber
put
Archive Email Subscriber
del
Restore Email Subscriber
patch
SMS Operations
Get SMS Agreement
get
Acquire phone number
post
Request phone number verification
put
Update phone number
put
Archive phone number
del
Restore phone number
patch
Get blocked TCPA entries
get
Get opt in lists
get
Get opt in sources
get
Create opt in list
post
Save opt in list
put
Send SMS to opt in list
post
Save opt in list source
put
Get all opt in list sources
get
Get outbound SMS
get
Count outbound SMS
get
Get outbound SMSes by page
get
Get opt in list subscribers
get
Get opt in list subscribers by page
get
Count opt in list subscribers
get
Import opt in list subscribers
post
Export opt in list subscribers
post
Get opt in source subscribers
get
Count opt in source subscribers
get
Get payment object broadcasts
get
Create imported list
post
Save imported list
put
Get imported list recipients
get
Get imported list recipients by page
get
Count imported list recipients
get
Add new recipient in an imported list
post
Archive recipient
del
Restore recipient
patch
Import imported list recipients
post
Import imported list recipients from a given membership tier
post
Export imported list recipients
post
Retrieve the message segments used by the merchant within the current billing cycle
get
SMS Subscribers
Get all SMS Subscribers
get
Create SMS Subscriber
post
Update SMS Subscriber
put
Archive SMS Subscriber
del
Restore SMS Subscriber
patch
MOTIVATE CUSTOMERS
Promotion Codes
Get all Promotion Codes
get
Create Promotion Code
post
Update Promotion Code
put
Archive Promotion Code
del
Restore Promotion Code
patch
Prizes
Get all Prizes
get
Get Prize
get
Update Prize
put
Archive Prize
del
Restore Prize
patch
Create Prize
post
Get Prizes awarded
get
Dynamic Vouchers
Get all Dynamic Voucher Campaigns
get
Get Dynamic Voucher Campaign
get
Update Dynamic Voucher Campaign
put
Get Dynamic Voucher Campaign Redemptions
get
Create Dynamic Voucher Campaign
post
Archive Dynamic Voucher Campaign
del
Restore Dynamic Voucher Campaign
patch
Get the reach statistics of all the dynamic vouchers
get
Get the reach statistics of an individual dynamic voucher
get
Merchant Credits
Count all Merchant Credits
get
Get Merchant Credits
post
Get Merchant Credit
get
Update Merchant Credit
put
Archive Merchant Credit
del
Restore Merchant Credit
patch
Create Merchant Credit
post
Search for Merchant Credits with Member ID
post
Get history
post
Get redemption log
post
Static Voucher Campaigns
Get all Static Vouchers Campaigns
get
Get Static Vouchers Campaign
get
Count vouchers in Static Vouchers Campaign
get
Count redeemed vouchers in Static Vouchers Campaign
get
Get redeemed vouchers in Static Vouchers Campaign
get
Duplicate Static Vouchers Campaign
post
Get vouchers in Static Vouchers Campaign
get
Get a page of vouchers in a Static Voucher Campaign
get
Get Static Vouchers Campaign traffic
get
Preview generated broadcast messages by page
put
Create Static Voucher Campaign with single voucher
post
Update Static Voucher Campaign with single voucher
put
Import Static Voucher Campaign
post
Create Static Voucher Campaign
post
Archive Static Voucher Campaign
del
Restore Static Voucher Campaign
patch
Update Static Voucher Campaign
put
Get Static Voucher Campaign performance overview
get
Get the reach statistics of all Static Voucher Campaigns
get
Get the reach statistics of a single Static Voucher Campaign
get
Static Vouchers
Get Static Voucher
get
Update Static Voucher
put
Delete Static Voucher
del
Create Static Voucher
post
Get reach statistics of all Static Vouchers
get
Get reach statistics of a single Static Voucher
get
Tickets
Get Ticket
get
Update Ticket
put
Archive Ticket
del
Restore Ticket
patch
Create Ticket
post
REWARD MEMBERS
Club Members
Count Members
get
Get Members
post
Get Member
get
Update Member
put
Archive Member
del
Restore Member
patch
Create Member
post
Search for Members
post
Get Member history
post
Get Member redemption log
post
Membership Tiers
Get all Membership Tiers
get
Get all Membership Tiers with member count
get
Get Membership Tier
get
Update Membership Tier
put
Archive Membership Tier
del
Restore Membership Tier
patch
Create Membership Tier
post
Get Membership Tier history
post
Get Membership Tier redemption log
post
CONNECT INTEGRATIONS
InfoGenesis Reports
Get request
get
Get requests
post
Get responses
post
Get response errors
get
Get lookup requests
post
Get lookup request errors
post
Get redemptions
post
Get transactions
post
Get redeemed static vouchers
post
Get refunded static vouchers
post
Get refunds
post
Get authorizations
post
Get redeemed unique posting IDs
get
Get refunded unique posting IDs
post
Get campaign information
post
Count redeemed ad credits
post
Count refunded ad credits
post
Count redeemed merchant credits
post
Count refunded merchant credits
post
Count redeemed membership points
post
Count refunded membership points
post
Count tier redemptions
post
Count tier refunds
post
Count dynamic voucher redemptions
post
Count dynamic voucher refunds
post
Count static voucher redemptions
post
Count static voucher refunds
post
Wallet Transaction Ledger
Get ledger entries
get
Point-of-Sale Configuration
Get all PoS machines
get
Create PoS machine
post
Update PoS machine
put
Archive PoS machine
del
Restore PoS machine
patch
Wallet Mobile Terminal
Get item
get
Redeem item
post
Search for Member's rewards
get
Shopify Terminal
Get item
get
Redeem item
post
Refund transaction
post
Wallet Web Terminal
Get item
get
Redeem item
post
Refund transaction
post
Wix Terminal
Get item
get
Redeem item
post
Refund transaction
post
WooCommerce Terminal
Get item
get
Redeem item
post
Refund transaction
post
REVIEW ANALYTICS
Analytics
Dashboard Summaries
CHANGE SETTINGS
Billing & Payments
Get usage summary
get
Save payment method
put
Verify payment method
get
Get merchant's industry
get
Set payment method as default
post
Get payment methods
get
Get subscription
get
Get invoices
get
Get upcoming invoices
get
Change billing plan
put
Cancel billing plan
del
Get add-on products
get
Buy add-on product
post
Get special offers
get
Buy special offer
post
Employees
Create employee peer
post
Set profile picture
put
Update peer
put
Get employee info
get
Get employee's permissions
get
Mark alerts as read
patch
Get all messages
get
Mark messages as read
patch
Changes the employee's email notification preference to enabled or disabled
put
Get peer permissions
get
API Keys
Get API Keys
get
Get API Key
get
Update API Key
put
Archive API Key
del
Create API Key
post
Modify peer's roles
put
Remove peer from all roles
del
Add peer to roles
post
Export static voucher campaign
put
Presign file for upload
post
Create file
post
Get URL for file download
get
Get URL to download a failed import
get
Import club members
post
Export club members
put
Update club members
put
Import merchant credits
post
Export merchant credits
put
Create employee alert
get
Mark export data files as read
put
Get peer activity
get
Send help desk response
post
Resolve help desk request
patch
Get all opt in list sources
get
Get opt in list source
get
Get all dynamic vouchers
get
Create media file
post
Delete media file
del
Get all media files
get
Create document
post
Delete document
del
Get all documents
get
Schedule SMS Campaign Broadcast
post
Schedule Simple SMS broadcast to list
post
Schedule Simple SMS broadcast to recipient
post
Schedule Dynamic Voucher to list
post
Schedule Dynamic Voucher to recipient
post
Schedule Ad Credit
post
Authentication
Login
post
Retrieve session token status
get
Register
post
Merchant
Update merchant details
put
Update points of contact
put
Update POS Integration
put
Get all employees
get
Get public representative employees of the merchant
get
Get wallet configuration
get
Get custom roles
get
Get all phone numbers
get
Get phone number
get
Get all TCPA Filters
get
Get help desk requests
get
Get inbound SMSes
get
Count inbound SMSes
get
Get inbound SMSes by page
get
Export inbound messages
put
Get outbound SMSes
get
Export outbound messages
put
Get all opt in lists
get
Get opt in list
get
Get all imported lists
get
Get imported list
get
Get all simple SMS broadcasts
get
Get all dynamic voucher broadcasts
get
Get all ad credit broadcasts
get
Get all static voucher campaign broadcasts
get
Archive payment object broadcast
del
Terminate (close) the merchant account
del
System
Get role's audit log
get
Get role
get
Delete role
del
Update role
put
Get employees with role
get
Get webpages for role
get
Create role
post
Countries
Get all Countries with ISO abbreviations & Telephone country code prefixes
get
Industries
Get all Industries & Pricing Plans
get
Get all Industries & Pricing Plans with trimmed metadata
get
WALLET UI
Customer
Get all static vouchers
get
Get active static vouchers
get
Get upcoming static vouchers
get
Get expired static vouchers
get
Get redeemed static vouchers
get
Get refunded static vouchers
get
Find members with phone number
post
Find members with memberID
post
Get Wallet Views for Session
get
Wallet Configuration
Update wallet record
put
Update payment design for merchant credits
put
Interactions
Identify item
get
Request Merchant URL
post
Get payment objects (token-scoped)
post
Get page (token-scoped)
post
Get a merchant's active dynamic vouchers
get
Get a customer's static vouchers on the basis of a given voucher ID
get
Get static voucher
get
Get dynamic voucher
get
Get member information
get
Create ad credit scan
post
Get multiple credit scans w/ array of IDs
post
Get vanity handle
get
Get ICS for live event
get
Download a representative's Virtual Business Card
get
Download a non-representative's Virtual Business Card
get
Create email subscriber
post
Create sms subscriber
post
Claim a ticket by ID
put
Get a customer's upcoming tickets via phone verification token
post
WEBHOOKS
Visitors.Authentiation.success
Visitors.Authentiation.success
post
Visitors.CalendarEvent.downloaded
Visitors.CalendarEvent.downloaded
post
Visitors.BusinessCard.downloaded
Visitors.BusinessCard.downloaded
post
Subscribers.Email.opt_in
Subscribers.Email.opt_in
post
Subscribers.SMS.default_opt_in
Subscribers.SMS.default_opt_in
post
Subscribers.SMS.keyword_opt_in
Subscribers.SMS.keyword_opt_in
post
Customers.StaticVoucher.redeemed
Customers.StaticVoucher.redeemed
post
Customers.StaticVoucher.refunded
Customers.StaticVoucher.refunded
post
Customers.Prize.redeemed
Customers.Prize.redeemed
post
Customers.Prize.refunded
Customers.Prize.refunded
post
Customers.DynamicVoucher.redeemed
Customers.DynamicVoucher.redeemed
post
Customers.DynamicVoucher.refunded
Customers.DynamicVoucher.refunded
post
Customers.MerchantCredit.redeemed
Customers.MerchantCredit.redeemed
post
Customers.MerchantCredit.refunded
Customers.MerchantCredit.refunded
post
Customers.Ticket.redeemed
Customers.Ticket.redeemed
post
Customers.Ticket.claimed
Customers.Ticket.claimed
post
Customers.Ticket.unclaimed
Customers.Ticket.unclaimed
post
Members.Points.redeemed
Members.Points.redeemed
post
Members.Points.refunded
Members.Points.refunded
post
Members.Tier.redeemed
Members.Tier.redeemed
post
Members.Tier.refunded
Members.Tier.refunded
post
WalletPlatform.LedgerEntry.created
WalletPlatform.LedgerEntry.created
post
WalletPlatform.Invoice.created
WalletPlatform.Invoice.created
post
WalletPlatform.Invoice.paid
WalletPlatform.Invoice.paid
post
WalletPlatform.Subscription.changed
WalletPlatform.Subscription.changed
post
WalletPlatform.AddOn.purchased
WalletPlatform.AddOn.purchased
post
WalletPlatform.PaymentMethod.added
WalletPlatform.PaymentMethod.added
post
wallet-api
App-to-Person (A2P) Registration
Begin A2P Application (Standard: a private, for-profit business with an EIN)
post
Begin A2P Application (Public: a publicly-traded company; requires stock exchange, ticker, and brand contact email)
post
Begin A2P Application (Non-profit)
post
Begin A2P Application (Government)
post
Begin A2P Application (Sole Proprietor: no EIN; requires a mobile number for OTP verification)
post
Billing & Payments
Create a Stripe Billing Portal session
post
Run a consumer-authorized financing soft credit inquiry (LeadFi, tri-bureau) Consumer-initiated FCRA permissible purpose: the authenticated user explicitly authorizes the check (disclosure text is submitted verbatim and persisted as evidence). The consent IP is captured server-side from the request; the inquiry is refused when it cannot be captured. Fails fast until LeadFi credentials are provisioned (go-live gated on counsel sign-off).
post
Set merchant's industry
put
Stripe Connect
Get Stripe Connect account status Observability for Flow B ecommerce: the connected-account id and capability flags for the authenticated merchant, plus the derived onboarding status and the server-side ecommerce eligibility flag. Returns the defined not-started shape (accountId null) rather than 404 when onboarding has not begun.
get
Create a Stripe Connect onboarding link Creates the merchant's STANDARD connected account on first call (pass-through model; the merchant owns their Stripe relationship) and returns a hosted onboarding link (single-use, expiring). returnUrl/refreshUrl are validated against the origin allowlist. Not a fund-moving write; 403 when the merchant's plan does not include Connect ecommerce.
post
Get a read-only Connect payments summary Balances, recent payouts, and recent charges (up to 10 each) for the merchant's connected account, in Stripe minor units with currency codes. Read-only observability; Wallet is not in the Flow B money path.
get
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
SMS Messages
Estimate SMS/MMS segments for a message
post
Get the merchant's outbound-SMS send-freeze status (KAN-440).
get
Short Links
Get Short Link traffic (paginated)
get
Orders
List the authenticated merchant's orders Newest first, each hydrated with its line items. Read-only receipts/status for Flow B.
get
Fetch one of the authenticated merchant's orders by id Returns the order with its line items. 403-family error if the order belongs to another merchant (ownership is asserted server-side).
get
Redact (soft-delete) the donor note on one of the authenticated merchant's orders KAN-862 takedown path: hides a guest-supplied tip / donation note from every surface. The original text is RETAINED server-side (soft-delete) for a possible exposure / legal review; no "[redacted]" placeholder is shown. Idempotent (an order with no note, or an already-redacted note, is a no-op). 403-family error if the order belongs to another merchant (ownership is asserted server-side).
post
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 upload
post
Google Wallet Subscribers
Get all subscribers
get
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
Get all Assistants
get
Get Assistant
get
Update Assistant
put
Archive Assistant
del
Restore Assistant
patch
Create Assistant
post
Get all Threads
get
Get Thread's Messages
get
Create Thread
post
Update Thread
put
Archive Thread
del
Restore Thread
patch
Create Run on Thread
post
Add Message to Thread
post
Get all VectorStores
get
Create VectorStore
post
Update VectorStore
put
Archive VectorStore
del
Restore VectorStore
patch
Prizes
Create a prize-game promotion Creates one instant-win promotion for the authenticated merchant. Guardrails enforced: purchase-independent trigger only, odds within (0,1], currency-valued prizes belonging to the merchant, total prize-pool value above $500 requires registration attestation, minimum age 18, and only one live promotion per game type.
post
List the merchant's prize-game promotions
get
Update a prize-game promotion Deactivate a promotion or bring its end date forward.
put
Gift Cards
Purchase a gift card Runs the (mock) Connect direct charge to the merchant, then issues a funded, reloadable gift card. Optionally gifts it to a recipient. Requires the merchant's Stripe Connect account to be active (charges enabled).
post
Create a gift-certificate deal (draft) Creates the discounted "deal" template (product/service entitlement, retail + sale price, quantity, validity) as a DRAFT. It is not purchasable until published. Authoring a draft does not require Stripe Connect.
post
Publish a certificate deal (put it on sale) Flips a draft deal live so guests can buy certificates from it. Requires the merchant's Stripe Connect account to be active (charges enabled), since a purchase is a direct charge to that account.
post
Purchase a certificate from a deal Runs the (mock) Connect direct charge of the deal's discounted sale price to the merchant, then mints a single-use certificate from the deal. Optionally gifts it to a recipient.
post
Claim a gifted card or certificate Claims a gift into the recipient's wallet (guest-to-guest). For a certificate with the gift-redemption requirement, the claimer must be someone other than the purchaser.
post
Fetch a gift card or certificate by id
get
Fetch a certificate deal by id
get
Wallet Configuration
Generate Android TWA signing keystore
post
Interactions
Create a guest checkout PaymentIntent (KAN-802)
post
Fetch a guest order receipt (KAN-802)
get
Get the active prize-game promotion Guest-facing read that drives the game UI and the Official Rules surface: sponsor (the merchant), title, honest odds disclosure, prize list, play limits, and the minimum age. Returns { active: false } when the merchant has no live promotion for the game.
get
Play a prize game Server-authoritative instant-win play (KAN-307): the server decides win/lose and the prize with a crypto-grade RNG, enforces the per-guest play limit and prize inventory, records the audited play with its odds snapshot, and on a win issues the prize into the guest's My Prizes via the existing Prize (Advertisement Credit) scan path. Requires the OTP-verified phone token; carries NO payment surface of any kind (plays are always free).
post
Create a guest tip / donation PaymentIntent (KAN-861)
post
Industries
Get the free-by-default (Visitor tier) plan
get
Powered by
Analytics
Updated 10 months ago
Refund transaction
Dashboard Summaries
Did this page help you?
Yes
No
Updated 10 months ago
Refund transaction
Dashboard Summaries
Did this page help you?
Yes
No
Copy Page
