Jump to Content
Wallet Inc: Developer Hub
HomeGuidesAPI ReferenceChangelog
Log InWallet Inc: Developer Hub
API Reference
Log In
HomeGuidesAPI ReferenceChangelog

Welcome! (Start Here)

  • API Reference: Overview
  • Creating an API Key
  • Using Postman

APPLY BRANDING

  • QR Code Designs
    • Get all QR Code Designsget
    • Get QR Code Designget
    • Update QR Code Designput
    • Archive QR Code Designdelete
    • Restore QR Code Designpatch
    • Create QR Code designpost
  • Payment Designs
    • Get all payment designsget
    • Get payment designget
    • Update payment designput
    • Archive payment designdelete
    • Restore payment designpatch
    • Create payment designpost

ATTRACT VISITORS

  • Amenities
    • Get all Amenitiesget
    • Create Amenitypost
    • Update Amenityput
    • Archive Amenitydelete
    • Restore Amenitypatch
  • Dining
    • Get all Dining infoget
    • Create Dining infopost
    • Update Dining infoput
    • Archive Dining infodelete
    • Restore Dining infopatch
  • Gaming
    • Get all Gaming detailsget
    • Create Gaming infopost
    • Update Gaming infoput
    • Archive Gaming infodelete
    • Restore Gaming infopatch
  • Gallery
    • Get all Gallery Imagesget
    • Create Gallery Imagepost
    • Update Gallery Imageput
    • Archive Gallery Imagedelete
    • Restore Gallery Imagepatch
  • Quick Links
    • Get all Quick Linksget
    • Get Quick Linkget
    • Update Quick Linkput
    • Archive Quick Linkdelete
    • Restore Quick Linkpatch
    • Create Quick Linkpost
  • Quick Links Section
    • Get all quick link sectionsget
    • Create quick link sectionpost
    • Update quick link sectionput
    • Archive quick link sectiondelete
    • Restore quick link sectionpatch
  • Lounge
    • Get all Loungesget
    • Create Loungepost
    • Update Loungeput
    • Archive Loungedelete
    • Restore Loungepatch
  • Short Links
    • Get all Short Linksget
    • Get Short Linkget
    • Update Short Linkput
    • Archive Short Linkdelete
    • Restore Short Linkpatch
    • Create Short Linkpost
    • Get Short Link trafficget
  • News
    • Get all News & Blog postsget
    • Create News & Blog postpost
    • Update News & Blog postput
    • Archive News & Blog postdelete
    • Restore News & Blog postpatch
  • Performances
    • Get all Performancesget
    • Get Performanceget
    • Update Performanceput
    • Archive Performancedelete
    • Restore Performancepatch
    • Update performance's Ticket Settingspost
    • Create performancepost
    • Import Performance's Ticketspost
    • Export Performance's Ticketspost
    • Count Performance's claimed Ticketsget
    • Count Performance's redeemed Ticketsget
    • Get Performance's Ticketsget
    • Get Peformance's Ticketsget
  • Products
    • Get all Productsget
    • Create Productpost
    • Update Productput
    • Archive Productdelete
    • Restore Productpatch
  • Room Rates
    • Get all Rooms & Ratesget
    • Create Room & Ratepost
    • Update Room & Rateput
    • Archive Room & Ratedelete
    • Restore Room & Ratepatch
  • Services
    • Get all Servicesget
    • Create Servicepost
    • Update Serviceput
    • Archive Servicedelete
    • Restore Servicepatch
  • Videos
    • Get all Videosget
    • Create Videopost
    • Update Videoput
    • Archive Videodelete
    • Restore Videopatch
  • Virtual Business Card
    • Get all Virtual Business Cardsget
    • Get Virtual Business Cardget
    • Update Virtual Business Cardput
    • Archive Virtual Business Carddelete
    • Restore Virtual Business Cardpatch
    • Create Virtual Business Cardpost
    • Get Virtual Business Card trafficget

EXCITE SUBSCRIBERS

  • Apple Wallet Subscribers
    • Get all subscribersget
    • Get subscriber activityget
  • App-to-Person (A2P) Registration
    • Get A2P Applicationget
    • Create A2P Applicationpost
    • Get A2P Registrationget
    • Update A2P Applicationput
  • Email Subscribers
    • Get all Email Subscribersget
    • Create Email Subscriberpost
    • Update Email Subscriberput
    • Archive Email Subscriberdelete
    • Restore Email Subscriberpatch
  • SMS Operations
    • Get SMS Agreementget
    • Acquire phone numberpost
    • Request phone number verificationput
    • Update phone numberput
    • Archive phone numberdelete
    • Restore phone numberpatch
    • Get blocked TCPA entriesget
    • Get opt in listsget
    • Get opt in sourcesget
    • Create opt in listpost
    • Save opt in listput
    • Send SMS to opt in listpost
    • Save opt in list sourceput
    • Get all opt in list sourcesget
    • Get outbound SMSget
    • Count outbound SMSget
    • Get outbound SMSes by pageget
    • Get opt in list subscribersget
    • Get opt in list subscribers by pageget
    • Count opt in list subscribersget
    • Import opt in list subscriberspost
    • Export opt in list subscriberspost
    • Get opt in source subscribersget
    • Count opt in source subscribersget
    • Get payment object broadcastsget
    • Create imported listpost
    • Save imported listput
    • Get imported list recipientsget
    • Get imported list recipients by pageget
    • Count imported list recipientsget
    • Add new recipient in an imported listpost
    • Archive recipientdelete
    • Restore recipientpatch
    • Import imported list recipientspost
    • Import imported list recipients from a given membership tierpost
    • Export imported list recipientspost
    • Retrieve the number of messages sent by the merchant within the current billing cycleget
  • SMS Subscribers
    • Get all SMS Subscribersget
    • Create SMS Subscriberpost
    • Update SMS Subscriberput
    • Archive SMS Subscriberdelete
    • Restore SMS Subscriberpatch

MOTIVATE CUSTOMERS

  • Promotion Codes
    • Get all Promotion Codesget
    • Create Promotion Codepost
    • Update Promotion Codeput
    • Archive Promotion Codedelete
    • Restore Promotion Codepatch
  • Prizes
    • Get all Prizesget
    • Get Prizeget
    • Update Prizeput
    • Archive Prizedelete
    • Restore Prizepatch
    • Create Prizepost
    • Get Prizes awardedget
  • Dynamic Vouchers
    • Get all Dynamic Voucher Campaignsget
    • Get Dynamic Voucher Campaignget
    • Update Dynamic Voucher Campaignput
    • Get Dynamic Voucher Campaign Redemptionsget
    • Create Dynamic Voucher Campaignpost
    • Archive Dynamic Voucher Campaigndelete
    • Restore Dynamic Voucher Campaignpatch
    • Get the reach statistics of all the dynamic vouchersget
    • Get the reach statistics of an individual dynamic voucherget
  • Merchant Credits
    • Count all Merchant Creditsget
    • Get Merchant Creditspost
    • Get Merchant Creditget
    • Update Merchant Creditput
    • Archive Merchant Creditdelete
    • Restore Merchant Creditpatch
    • Create Merchant Creditpost
    • Search for Merchant Credits with Member IDpost
    • Get historypost
    • Get redemption logpost
  • Static Voucher Campaigns
    • Get all Static Vouchers Campaignsget
    • Get Static Vouchers Campaignget
    • Count vouchers in Static Vouchers Campaignget
    • Count redeemed vouchers in Static Vouchers Campaignget
    • Get redeemed vouchers in Static Vouchers Campaignget
    • Duplicate Static Vouchers Campaignpost
    • Get vouchers in Static Vouchers Campaignget
    • Get vouchers in Static Vouchers Campaignget
    • Get Static Vouchers Campaign trafficget
    • View vouchers in Static Voucher Campaignput
    • Create Static Voucher Campaign with single voucherpost
    • Update Static Voucher Campaign with single voucherput
    • Import Static Voucher Campaignpost
    • Create Static Voucher Campaignpost
    • Archive Static Voucher Campaigndelete
    • Restore Static Voucher Campaignpatch
    • Update Static Voucher Campaignput
    • Get Static Voucher Campaign performance overviewget
    • Get the reach statistics of all Static Voucher Campaignsget
    • Get the reach statistics of a single Static Voucher Campaignget
  • Static Vouchers
    • Get Static Voucherget
    • Update Static Voucherput
    • Delete Static Voucherdelete
    • Create Static Voucherpost
    • Get reach statistics of all Static Vouchersget
    • Get reach statistics of a single Static Voucherget
  • Tickets
    • Get Ticketget
    • Update Ticketput
    • Archive Ticketdelete
    • Restore Ticketpatch
    • Create Ticketpost

REWARD MEMBERS

  • Club Members
    • Count Membersget
    • Get Memberspost
    • Get Memberget
    • Update Memberput
    • Archive Memberdelete
    • Restore Memberpatch
    • Create Memberpost
    • Search for Memberspost
    • Get Member historypost
    • Get Member redemption logpost
  • Membership Tiers
    • Get all Membership Tiersget
    • Get all Membership Tiers with member countget
    • Get Membership Tierget
    • Update Membership Tierput
    • Archive Membership Tierdelete
    • Restore Membership Tierpatch
    • Create Membership Tierpost
    • Get Membership Tier historypost
    • Get Membership Tier redemption logpost

CONNECT INTEGRATIONS

  • InfoGenesis Reports
    • Get requestget
    • Get requestspost
    • Get responsespost
    • Get response errorsget
    • Get queriespost
    • Get queries errorspost
    • Get redemptionspost
    • Get transactionspost
    • Get redeemed static voucherspost
    • Get refunded static voucherspost
    • Get refundspost
    • Get authorizationspost
    • Get redeemed unique posting IDsget
    • Get refunded unique posting IDspost
    • Get campaign informationpost
    • Count redeemed ad creditspost
    • Count refunded ad creditspost
    • Count redeemed merchant creditspost
    • Count refunded merchant creditspost
    • Count redeemed membership pointspost
    • Count refunded membership pointspost
    • Count tier redemptionspost
    • Count tier refundspost
    • Count dynamic voucher redemptionspost
    • Count dynamic voucher refundspost
    • Count static voucher redemptionspost
    • Count static voucher refundspost
  • Wallet Transaction Ledger
    • Get ledger entriesget
  • Point-of-Sale Configuration
    • Get all PoS machinesget
    • Create PoS machinepost
    • Update PoS machineput
    • Archive PoS machinedelete
    • Restore PoS machinepatch
  • Wallet Mobile Terminal
    • Get itemget
    • Redeem itempost
    • Search for Member's rewardsget
  • Shopify Terminal
    • Get itemget
    • Redeem itempost
    • Refund transactionpost
  • Wallet Web Terminal
    • Get itemget
    • Redeem itempost
    • Refund transactionpost
  • Wix Terminal
    • Get itemget
    • Redeem itempost
    • Refund transactionpost
  • WooCommerce Terminal
    • Get itemget
    • Redeem itempost
    • Refund transactionpost

REVIEW ANALYTICS

  • Analytics
    • Get distinct wallet sessionsget
    • Count total sessionsget
    • Count new sessionsget
    • Count referring sitesget
    • Count exit clicksget
    • Count authenticated sessionsget
    • Get wallet object counts within a given time frameget
    • Get wallet object counts within a given time frame that have a valid phone verification tokenget
    • Get session activityget
    • Get session activity by wallet page view IDget
    • Get a campaign's wallet page viewsget
    • Get a static voucher's wallet page viewsget
    • Get wallet page views of itemget
    • Count membersget
    • Count redeemed pointsget
    • Count refunded pointsget
    • Get redeemed amoun̥t of tiersget
    • Get refunded amount of tiersget
    • Count merchant creditsget
    • Get redeemed amount of merchant creditsget
    • Get refunded amount of merchant creditsget
    • Count help desk requestsget
    • Count daily help desk requestsget
    • Count resolved help desk requests by dateget
    • Count unresolved help desk requests by dateget
    • Count resolved help desk requests by employeeget
    • Count TCPA (STOP) entries by dateget
    • Count TCPA (STOP) entries by phone numberget
    • Count created TCPA Filter entries by dateget
    • Count deleted TCPA Filter entries by dateget
    • Count opt in list subscribersget
    • Count opt in list subscribers by dateget
    • Count opt in list subscribersget
    • Count opt in list subscribersget
    • Count created broadcasts by dateget
    • Count scheduled broadcasts by dateget
    • Count scheduled broadcasts by phone numberget
    • Count scheduled SMS broadcasts by dateget
    • Count scheduled broadcasts by employeeget
    • Get execution time of completed broadcastsget
    • Count sent outbound messages by phone numberget
    • Count sent outbound messages by dateget
    • Count delivered outbound messages by phone numberget
    • Count delivered outbound messages by dateget
    • Count ad credits by value typeget
    • Count ad credits by payment designget
    • Count ad credits by employeeget
    • Count scans of ad credits by dateget
    • Count scans of ad credits by Ad Creditget
    • Count redemptions of ad credits by dateget
    • Count redemptions of ad credits by Ad Creditget
    • Get redemption amount of ad credits by dateget
    • Get redemption amount of ad credits by Ad Creditget
    • Count refunds of ad credits by dateget
    • Count refunds of ad credits by Ad Creditget
    • Get refund amount of ad credits by dateget
    • Get refund amount of ad credits by Ad Creditget
    • Count dynamic vouchers by payment designget
    • Count dynamic vouchers by employeeget
    • Count redemptions of dynamic vouchers by dateget
    • Count redemptions of dynamic vouchers by dynamic voucherget
    • Get redemption amount of dynamic vouchers by dateget
    • Get redemption amount of dynamic vouchers by dynamic voucherget
    • Count refunds of dynamic vouchers by dateget
    • Count refunds of dynamic vouchers by dynamic voucherget
    • Get refund amount of dynamic vouchers by dateget
    • Get refund amount of dynamic vouchers by dynamic voucherget
    • Count campaigns by value typeget
    • Count campaigns by payment designget
    • Count campaigns by employeeget
    • Count created campaigns by campaignget
    • Get offer vs redeemed amount by campaignget
    • Count redemptions of campaigns by dateget
    • Count redemptions of campaigns by Campaignget
    • Get redemption amount of campaigns by dateget
    • Get redemption amount of campaigns by Campaignget
    • Get refund amount of campaigns by dateget
    • Get refund amount of campaigns by Campaignget
    • Get refund amount of campaigns by dateget
    • Get refund amount of campaigns by Campaignget
    • Get refund amount of campaigns by Campaignget
    • Get refund amount of campaigns by Campaignget
    • Get refund amount of campaigns by Campaignget
    • Get refund amount of campaigns by Campaignget
  • Dashboard Summaries
    • Count new sessionsget
    • Count Performancesget
    • Count tiersget
    • Count membersget
    • Count POS Machinesget
    • Count POS Transactionsget
    • Count POS redemptionsget
    • Count POS refundsget
    • Count Outbound SMSget
    • Count employeesget
    • Count active static vouchersget
    • Count phone numbersget
    • Count opt in listsget
    • Count opt in sourcesget
    • Count Apple Wallet Subscribersget
    • Count Wallet page viewsget
    • Count News Articlesget
    • Count Performancesget

CHANGE SETTINGS

  • Billing & Payments
    • Get usage summaryget
    • Save payment methodput
    • Verify payment methodget
    • Get merchant's industryget
    • Set payment method as defaultpost
    • Get payment methodsget
    • Get subscriptionget
    • Get invoicesget
    • Get upcoming invoicesget
    • Change billing planput
    • Cancel billing plandelete
    • Get add-on productsget
    • Buy add-on productpost
    • Get special offersget
    • Buy special offerpost
  • Employees
    • Create employee peerpost
    • Set profile pictureput
    • Update peerput
    • Get employee infoget
    • Get employee's permissionsget
    • Mark alerts as readpatch
    • Get all messagesget
    • Mark messages as readpatch
    • Changes the employee's email notification preference to enabled or disabledput
    • Get peer permissionsget
    • API Keys
      • Get API Keysget
      • Get API Keyget
      • Update API Keyput
      • Archive API Keydelete
      • Create API Keypost
    • Modify peer's rolesput
    • Remove peer from all rolesdelete
    • Add peer to rolespost
    • Export static voucher campaignput
    • Presign file for uploadpost
    • Create filepost
    • Get URL for file downloadget
    • Get URL to download a failed importget
    • Import club memberspost
    • Export club membersput
    • Update club membersput
    • Import merchant creditspost
    • Export merchant creditsput
    • Create employee alertget
    • Mark export data files as readput
    • Get peer activityget
    • Send help desk responsepost
    • Resolve help desk requestpatch
    • Get all opt in list sourcesget
    • Get opt in list sourceget
    • Get all dynamic vouchersget
    • Create media filepost
    • Delete media filedelete
    • Get all media filesget
    • Create documentpost
    • Delete documentdelete
    • Get all documentsget
    • Schedule SMS Campaign Broadcastpost
    • Schedule Simple SMS broadcast to listpost
    • Schedule Simple SMS broadcast to recipientpost
    • Schedule Dynamic Voucher to listpost
    • Schedule Dyanamic Voucher to recipientpost
    • Schedule Ad Creditpost
    • Authentication
      • Loginpost
      • Retrieve session token statusget
      • Logoutdelete
      • Registerpost
  • Merchant
    • Update merchant detailsput
    • Update billing contactput
    • Update POS Integrationput
    • Get all employeesget
    • Get public representative employees of the merchantget
    • Get wallet configurationget
    • Get custom rolesget
    • Get all phone numbersget
    • Get phone numberget
    • Get all TCPA Filtersget
    • Get help desk requestsget
    • Get inbound SMSesget
    • Count inbound SMSesget
    • Get inbound SMSes by pageget
    • Export inbound messagesput
    • Get outbound SMSesget
    • Export outbound messagesput
    • Get all opt in listsget
    • Get opt in listget
    • Get all imported listsget
    • Get imported listget
    • Get all simple SMS broadcastsget
    • Get all dynamic voucher broadcastsget
    • Get all ad credit broadcastsget
    • Get all static voucher campaign broadcastsget
    • Archive payment object broadcastdelete
    • Archive Merchantdelete
  • System
    • Get role's audit logget
    • Get roleget
    • Delete roledelete
    • Update roleput
    • Get employees with roleget
    • Get webpages for roleget
    • Create rolepost
    • Get payment prefixesget
  • 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
    • Get all white-labeled custom domains by industryget

WALLET UI/UX

  • Customer
    • Get all static vouchersget
    • Get active static vouchersget
    • Get upcoming static vouchersget
    • Get expired static vouchersget
    • Get redeemed static vouchersget
    • Get refunded static vouchersget
    • Find members with phone numberpost
    • Find members with memberIDpost
    • Get Wallet Views for Sessionget
  • Wallet Configuration
    • Update wallet recordput
    • Update payment design for merchant creditsput
  • Interactions
    • Identify itemget
    • Request Merchant URLpost
    • Get payment objects with token NOTE: This route exists because a token can completely change the dataset returned to the client. A simple fetch just logs the token with the request, but a fetchWithToken request can have a very different object returned to the client.post
    • Get page with token NOTE: This route exists because a token can completely change the dataset returned to the client. A simple fetch just logs the token with the request, but a fetchWithToken request can have a very different object returned to the client.post
    • Get a customer's static vouchers on the basis of a given voucher IDget
    • Get a customer's static vouchers on the basis of a given voucher IDget
    • Get static voucherget
    • Get dynamic voucherget
    • Get member informationget
    • Create ad credit scanpost
    • Get multiple credit scans w/ array of IDspost
    • Get vanity handleget
    • Get ICS for live eventget
    • Download a representative's Virtual Business Cardget
    • Download a non-representative's Virtual Business Cardget
    • Create email subscriberpost
    • Create sms subscriberpost
    • Update ticketput
    • Update ticketpost

WEBHOOKS

  • Visitors.Authentiation.success
    • postpost
  • Visitors.CalendarEvent.downloaded
    • postpost
  • Visitors.BusinessCard.downloaded
    • postpost
  • Subscribers.Email.opt_in
    • postpost
  • Subscribers.SMS.default_opt_in
    • postpost
  • Subscribers.SMS.keyword_opt_in
    • postpost
  • Customers.StaticVoucher.redeemed
    • postpost
  • Customers.StaticVoucher.refunded
    • postpost
  • Customers.Prize.redeemed
    • postpost
  • Customers.Prize.refunded
    • postpost
  • Customers.DynamicVoucher.redeemed
    • postpost
  • Customers.DynamicVoucher.refunded
    • postpost
  • Customers.MerchantCredit.redeemed
    • postpost
  • Customers.MerchantCredit.refunded
    • postpost
  • Customers.Ticket.redeemed
    • postpost
  • Customers.Ticket.claimed
    • postpost
  • Customers.Ticket.unclaimed
    • postpost
  • Members.Points.redeemed
    • postpost
  • Members.Points.refunded
    • postpost
  • Members.Tier.redeemed
    • postpost
  • Members.Tier.refunded
    • postpost
  • WalletPlatform.LedgerEntry.created
    • postpost
  • WalletPlatform.Invoice.created
    • postpost
  • WalletPlatform.Invoice.paid
    • postpost
  • WalletPlatform.Subscription.changed
    • postpost
  • WalletPlatform.AddOn.purchased
    • postpost
  • WalletPlatform.PaymentMethod.added
    • postpost