Loyalty Wallet

Introduction

The lifecycle of applying a loyalty wallet as a discount to an order follows a clear tree-step process, with your system receiving webhooks at each stage.

Webhooks

WebhookMethodPurpose
Get Loyalty Customer WalletGETThis webhook is triggered to retrieve a customer's wallet balance. Your system should respond with the customer's available funds in the form of cash and/or loyalty points. This data is essential for our system to display the customer's current balance, allowing them to make informed decisions about using their rewards.
Loyalty Order NotificationPOSTThis webhook is called when an end customer places an order. Here the loyalty provider can redeem the applied discounts created from the wallet.
Cancel Loyalty OrderPOSTThis webhook is called an order is cancelled. Here the loyalty provider can revert any redemptions or transactions done when the order was created