Jump to Content
Home
Guides
API Reference
Changelog
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
Home
Guides
API Reference
Changelog
My Requests
Search
JUMP TO
Developer Dashboard
My Requests
Welcome!
API Reference: Overview
Creating an API Key
Using Postman
Merchant & Employees
Merchant
Update merchant details
put
Update billing contact
put
Update POS Integration
put
Fetch all employees
get
Fetch public representative employees of the merchant
get
Fetch wallet configuration
get
Fetch custom roles
get
Fetch all phone numbers
get
Fetch phone number
get
Fetch all TCPA Filters
get
Fetch help desk requests
get
Fetch inbound SMSes
get
Count inbound SMSes
get
Fetch inbound SMSes by page
get
Export inbound messages
put
Fetch outbound SMSes
get
Export outbound messages
put
Fetch all opt in lists
get
Fetch opt in list
get
Fetch all imported lists
get
Fetch imported list
get
Fetch all simple SMS broadcasts
get
Fetch all dynamic voucher broadcasts
get
Fetch all ad credit broadcasts
get
Fetch all static voucher campaign broadcasts
get
Archive payment object broadcast
delete
Archive Merchant
delete
Employees
Create employee peer
post
Set profile picture
put
Update peer
put
Retrieve employee's webpages
get
Retrieve employee's webpages
get
Mark alerts as read
patch
Fetch all messages
get
Mark messages as read
patch
Changes the employee's email notification preference to enabled or disabled
put
Fetch peer permissions
get
Modify peer's roles
put
Remove peer from all roles
delete
Add peer to roles
post
Export static voucher campaign
put
Fetch static voucher campaigns
get
Fetch static voucher campaign groups
get
Create static voucher campaign group
post
Presign file for upload
post
Create file
post
Fetch URL for file download
get
Fetch 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
Fetch peer activity
get
Send help desk response
post
Resolve help desk request
patch
Fetch all opt in list sources
get
Fetch opt in list source
get
Fetch all dynamic vouchers
get
Create media file
post
Delete media file
delete
Fetch all media files
get
Create document
post
Delete document
delete
Fetch 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 Dyanamic Voucher to recipient
post
Schedule Ad Credit
post
Employee API Keys
Fetch all employee API Keys
get
Fetch API Key
get
Update employee API Key
put
Archive employee API Key
delete
Create employee API Key
post
Login And Logout
Login
post
Retrieve status of session token
get
Logout
delete
Employee Access
Register
post
Settings
Get active campaigns
get
Get vouchers count
get
Wallet UI
Customer
Fetch all static vouchers
get
Fetch active static vouchers
get
Fetch upcoming static vouchers
get
Fetch expired static vouchers
get
Fetch redeemed static vouchers
get
Fetch refunded static vouchers
get
Find members with phone number
post
Find members with memberID
post
Fetch Wallet Views for Session
get
News
Fetch all news articles
get
Create news article
post
Update news article
put
Archive news article
delete
Restore news article
patch
Performances
Fetch all performances
get
Create performance
post
Update performance
put
Archive performance
delete
Restore performance
patch
Interactions
Identify item
get
Identify item
post
Fetch payment object 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
Fetch 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
Fetch a customer's static vouchers on the basis of a given voucher ID
get
Fetch static voucher
get
Fetch dynamic voucher
get
Fetch member information
get
Create ad credit scan
post
Fetch vanity handle
get
Fetch ICS for live event
get
Fetch an employee's VCard
get
Image Grid
Fetch all images
get
Create image
post
Update image
put
Archive image
delete
Restore image
patch
Quick Links
Fetch all links
get
Fetch link book by id
get
Update link
put
Archive link
delete
Restore link
patch
Create link
post
Quick Links Section
Fetch all link book sections
get
Create link book section
post
Update link book section
put
Archive link book section
delete
Restore link book section
patch
Virtual Business Card
Fetch all VirtualBusinessCards
get
Fetch virtual business card
get
Update VirtualBusinessCard
put
Archive VirtualBusinessCard
delete
Restore VirtualBusinessCard
patch
Create VirtualBusinessCard
post
Fetch requests
get
Merchant URLs
Fetch all merchant urls
get
Fetch merchant url
get
Update merchant url
put
Archive merchant url
delete
Restore merchant url
patch
Create merchant url
post
Fetch requests
get
Configuration
Update wallet record
put
/v2/wallet/createPublicChatRoom
post
Update wallet record
put
Communications
Apple Wallet Subscribers
Fetch all subscribers
get
Fetch subscriber activity
get
SMS
Accept SMS agreement
post
Fetch SMS agreement
get
Acquire phone number
post
Request phone number verification
put
Update phone number
put
Archive phone number
delete
Restore phone number
patch
Fetch blocked TCPA entries
get
Fetch opt in lists
get
Fetch 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
Fetch all opt in list sources
get
Fetch outbound SMS
get
Count outbound SMS
get
Fetch outbound SMSes by page
get
Fetch opt in list subscribers
get
Fetch 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
Fetch opt in source subscribers
get
Count opt in source subscribers
get
Fetch payment object broadcasts
get
Create imported list
post
Save imported list
put
Fetch imported list recipients
get
Fetch imported list recipients by page
get
Count imported list recipients
get
Add new recipient in an imported list
post
Archive recipient
delete
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 number of messages sent by the merchant within the current billing cycle
get
Payments & Discounts
Promotion Codes
Fetch all promo codes
get
Create promo code
post
Update promo code
put
Archive promo code
delete
Restore promo code
patch
Club Members & Points
Count active members
get
Fetch members by page
post
Fetch member
get
Update member
put
Archive member
delete
Restore member
patch
Create member
post
Search for members
post
Fetch history
post
Fetch redemption log
post
Membership Tiers
Fetch all tiers
get
Fetch all tiers with member count
get
Fetch tier
get
Update tier
put
Archive tier
delete
Restore tier
patch
Create tier
post
Fetch history
post
Fetch redemption log
post
Advertisement Credits
Fetch all active ad credits
get
Fetch ad credit
get
Update ad credit
put
Archive ad credit
delete
Restore ad credit
patch
Create ad credit
post
Fetch scans
get
Payment Designs
Fetch all active payment designs
get
Fetch payment design
get
Update payment design
put
Archive payment design
delete
Restore payment design
patch
Create payment design
post
Dynamic Vouchers
Fetch all active dynamic vouchers
get
Fetch dynamic voucher
get
Update dynamic voucher
put
Fetch redemptions
get
Create dynamic voucher
post
Archive dynamic voucher campaign
delete
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
Fetch all active merchant credits
get
Fetch merchant credits by page
post
Fetch merchant credit
get
Update merchant credit
put
Archive merchant credit
delete
Restore merchant credit
patch
Create merchant credit
post
Search for merchant credits
post
Fetch history
post
Fetch redemption log
post
Static Voucher Campaigns
Fetches all static vouchers campaigns
get
Fetch static voucher campaign
get
Count loaded vouchers
get
Count redeemed vouchers
get
Fetch redeemed vouchers
get
Duplicate static voucher campaign
post
Fetch static vouchers
get
Fetch static vouchers by page
get
Fetch views
get
Preview static vouchers. This method has been deprecated. Please use /preview/page/{campaignID} for better performance.
put
Preview static vouchers by page
put
Create static voucher campaign with voucher
post
Update static voucher campaign with voucher
put
Import static voucher campaign
post
Create static voucher campaign
post
Archive static voucher campaign
delete
Restore static voucher campaign
patch
Update static voucher campaign
put
Fetch performance overview
get
Get the reach statistics of all the static voucher campaigns
get
Get the reach statistics of an individual static voucher campaign
get
Static Voucher Campaign Groups
Fetch all campaigns
get
Static Vouchers
Fetch static voucher
get
Update static voucher
put
Delete static voucher
delete
Create static voucher
post
Get the reach statistics of all the static vouchers
get
Get the reach statistics of an individual static voucher
get
Ecommerce
Shopify Terminal
Fetch item
get
Redeem item
post
Refund transaction
post
Wix Terminal
Fetch item
get
Redeem item
post
Refund transaction
post
WooCommerce Terminal
Fetch item
get
Redeem item
post
Refund transaction
post
Point of Sale
InfoGenesis Reports
Fetch InfoGenesis request with transaction ID
get
Fetch InfoGenesis requests with routing IDs
post
Fetch InfoGenesis responses with routing IDs
post
Fetch InfoGenesis response errors
get
Fetch InfoGenesis lookup requests
post
Fetch InfoGenesis lookup request errors
post
Fetch InfoGenesis redemptions
post
Fetch InfoGenesis transactions
post
Fetch redeemed static vouchers
post
Fetch refunded static vouchers
post
Fetch InfoGenesis refunds
post
Fetch InfoGenesis authorizations
post
Fetch redeemed InfoGenesis unique posting IDs
get
Fetch refunded InfoGenesis unique posting IDs
post
Fetch 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
Transaction Ledger
Fetch ledger transactions by page
get
Integrated Terminals
Fetch all POS machines
get
Create POS machine
post
Update POS machine
put
Archive POS machine
delete
Restore POS machine
patch
Mobile Terminal
Fetch item
get
Redeem item
post
Find member
get
Web Terminal
Fetch item
get
Redeem item
post
Refund transaction
post
System
Dashboard
Fetch widgets catalog
get
Count tiers
get
Count members
get
Count POS Machines
get
Count POS Transactions
get
Count POS redemptions
get
Count POS refunds
get
Count Outbound SMS
get
Count employees
get
Count active static vouchers
get
Count active static voucher campaigns
get
Count phone numbers
get
Count opt in lists
get
Count opt in sources
get
Count Apple Wallet Subscribers
get
Count Wallet page views
get
Count News Articles
get
Count Performances
get
System
Fetch role's audit log
get
Fetch role
get
Delete role
delete
Update role
put
Fetch employees with role
get
Fetch webpages for role
get
Create role
post
Utilities
Get payment prefixes
get
Industries
Fetch all industries
get
Billing
Fetch usage summary
get
Save payment method
put
Verify payment method
get
Fetch merchant's industry
get
Fetch subscription
get
Fetch all invoices
get
Fetch upcoming invoices
get
Change billing plan
put
Cancel billing plan and revert to default
delete
Fetch add-on products, or 1-time purchase products (non-subscription products)
get
Fetch add-on products, or 1-time purchase products (non-subscription products)
post
Fetch special offer products
get
Buy special offer
post
Countries
Fetch all countries
get
Analytics
Analytics
Fetch distinct wallet sessions
get
Count total sessions
get
Count new sessions
get
Count authenticated sessions
get
Fetch wallet object counts within a given time frame
get
Fetch wallet object counts within a given time frame that have a valid phone verification token
get
Fetch session activity
get
Fetch session activity by wallet page view ID
get
Fetch a campaign's wallet page views
get
Fetch a static voucher's wallet page views
get
Fetch wallet page views of item
get
Count members
get
Count redeemed points
get
Count refunded points
get
Fetch redeemed amoun̥t of tiers
get
Fetch refunded amount of tiers
get
Count merchant credits
get
Fetch redeemed amount of merchant credits
get
Fetch refunded amount of merchant credits
get
Count help desk requests by date
get
Count help desk requests by date
get
Count resolved help desk requests by date
get
Count unresolved help desk requests by date
get
Count resolved help desk requests by employee
get
Count TCPA (STOP) entries by date
get
Count TCPA (STOP) entries by phone number
get
Count created TCPA Filter entries by date
get
Count deleted TCPA Filter entries by date
get
Count opt in list subscribers
get
Count opt in list subscribers by date
get
Count opt in list subscribers
get
Count opt in list subscribers
get
Count created broadcasts by date
get
Count scheduled broadcasts by date
get
Count scheduled broadcasts by phone number
get
Count scheduled SMS broadcasts by date
get
Count scheduled broadcasts by employee
get
Fetch execution time of completed broadcasts
get
Count sent outbound messages by phone number
get
Count sent outbound messages by date
get
Count delivered outbound messages by phone number
get
Count delivered outbound messages by date
get
Count ad credits by value type
get
Count ad credits by payment design
get
Count ad credits by employee
get
Count scans of ad credits by date
get
Count scans of ad credits by Ad Credit
get
Count redemptions of ad credits by date
get
Count redemptions of ad credits by Ad Credit
get
Fetch redemption amount of ad credits by date
get
Fetch redemption amount of ad credits by Ad Credit
get
Count refunds of ad credits by date
get
Count refunds of ad credits by Ad Credit
get
Fetch refund amount of ad credits by date
get
Fetch refund amount of ad credits by Ad Credit
get
Count dynamic vouchers by payment design
get
Count dynamic vouchers by employee
get
Count redemptions of dynamic vouchers by date
get
Count redemptions of dynamic vouchers by dynamic voucher
get
Fetch redemption amount of dynamic vouchers by date
get
Fetch redemption amount of dynamic vouchers by dynamic voucher
get
Count refunds of dynamic vouchers by date
get
Count refunds of dynamic vouchers by dynamic voucher
get
Fetch refund amount of dynamic vouchers by date
get
Fetch refund amount of dynamic vouchers by dynamic voucher
get
Count campaigns by value type
get
Count campaigns by payment design
get
Count campaigns by employee
get
Count created campaigns by campaign
get
Fetch offer vs redeemed amount by campaign
get
Count redemptions of campaigns by date
get
Count redemptions of campaigns by Campaign
get
Fetch redemption amount of campaigns by date
get
Fetch redemption amount of campaigns by Campaign
get
Fetch refund amount of campaigns by date
get
Fetch refund amount of campaigns by Campaign
get
Fetch refund amount of campaigns by date
get
Fetch refund amount of campaigns by Campaign
get
Fetch refund amount of campaigns by Campaign
get
Fetch refund amount of campaigns by Campaign
get
Fetch refund amount of campaigns by Campaign
get
Fetch refund amount of campaigns by Campaign
get
••••••c0df
Endpoint
Method
Status
User Agent
