Jump to Content
Home
Guides
API Reference
Changelog
v1.0
v2.0
Log In
API Reference
Log In
v2.0
Home
Guides
API Reference
Changelog
Using your Scheme
All
Pages
Start typing to search…
JUMP TO
Loyale API
Getting Started
Authentication
Using your Scheme
Error Responses
Pagination
Filtering and Sorting
Enums
Dates and Times
Changelog
Account
Forgot Password
post
Change password
post
Activity
Get Activity
get
Auth
Get Token
post
Brand
Get Brand by ID
get
Get Brands
get
Contact
Get Contacts Match
post
CouponsLinked
Get Coupons Linked
get
Get Coupon Linked by ID
get
Get Coupon Usage
get
Customer
Get Customer by ID
get
Post Customer
post
Update Customer
put
Suspend Customer
put
Leave Scheme
post
Join Scheme
post
Delete Customer
post
Post Profile Picture
post
Delete Profile Picture
put
Get Balance
get
Get Levels
get
ExternalEventTrigger
External Event Trigger
post
GiftCardsLinked
Get Gift Cards Linked
get
Get Gift Card Linked by ID
get
Get Gift Card Usage
get
Group
Get Group by ID
get
Get Groups
get
Helpers
Filtering and Sorting for Get Currencies
Get Currencies
get
Filtering and Sorting for Get Countries
Get Countries
get
Filtering and Sorting for Get Towns
Get Towns
get
Level
Get Level by ID
get
Get Levels
get
Message
Post a new message
post
Outlet
Get Outlet by ID
get
Get Outlets
get
PostsLinked
Get Post Linked by ID
get
Get Posts Linked
get
PushToken
Post Push Token
post
Replace Push Token
post
Delete Push Token
del
Get Push Token by Value
get
Scheme
Get Scheme by ID
get
Transaction
Get Transaction by ID
get
Get Gain Rate
get
Get Transactions Grouped
get
Get Transactions
get
Legacy POS Api
Getting Started
Auth
Generate an access token for an Admin user.
post
ExternalPos
Get User Information
get
Register a new Transaction
post
Simulate a new Transaction
post
Register a new Refund Transaction
post
Get Coupon Information
get
Get Information on Updated Customers
get
Register a new Top Up Transaction
post
Create an OnHold transaction
post
Redeem an OnHold transaction
post
Remove an OnHold transaction
del
POS Api
Getting Started
CouponsLinked
Get List of Coupons Linked
get
Get Coupons Linked
get
Get Coupon Linked
get
Get Coupon Linked by ID
get
Get Coupon Linked by Barcode
get
Use Multiple Coupons
post
Use a Coupon Linked
post
Customer
Post Customer
post
Filtering and Sorting of Get Customers
Get Customers
get
Update Customer
put
Get Customer by ID
get
Get List of Customers
get
Get Customer
get
Get Customer by Barcode
get
Get Customer Balance
get
Get Balance by Customer ID
get
Get Balance by Customer Barcode
get
Get Customer Levels
get
Get Levels by Customer ID
get
Get Levels by Customer Barcode
get
Get Customer Offers
get
Create a Guest Customer
post
Join a Guest to the Scheme
put
ExternalEventTrigger
External Event Trigger
post
ExternalPos
Post Transaction Simulate
post
GiftCard
Get a List of Purchasable Gift Cards
get
GiftCardsLinked
Get List of Gift Cards Linked
get
Get Gift Cards Linked
get
Get Gift Card Linked
get
Get Gift Card Linked by ID
get
Get Gift Card Linked by Barcode
get
Use a Gift Card Linked
post
Activate a list of Gift Cards Linked
put
Generate a list of Gift Cards Linked
post
Transaction
Get Transaction by ID
get
Get Transactions
get
Integration API
Getting Started
Transaction Returns
Return a full transaction
post
Return a specific line item from a transaction
post
Return a custom transaction
post
Transactions
Process a transaction
post
Retrieve transaction status by unique ID
get
TerminalPos
/api/TerminalPos/Pos/Session
post
/api/TerminalPos/Pos/Session/{sessionId}
del
/api/TerminalPos/Pos/Session/{sessionId}
get
Powered by
Using your Scheme
Ask AI
Send the X-Scheme header with every request
