Use this guide to validate that your Loyalty integration correctly registers members, receives loyalty notifications, handles merchant activation, and supports deregistration flows.
Before deploying your Loyalty integration to production, validate that your system can successfully:
- Register loyalty members and link payment cards
- Receive and process loyalty notifications
- Handle merchant onboarding requests
- Support on-terminal loyalty registration flows
- Process deregistration requests
- Handle repeated notifications safely
The scenarios below represent the core integration behaviours expected for Loyalty API integrations.
Verify that your system can register a loyalty member and link their payment card for future loyalty activity.
- Create a test member in your system
- Register the member using the Loyalty API
- Link the payment card to the member profile
API endpoint POST /loyalty/members
- The member registration request succeeds
- The payment card is linked to the member
- Future transactions made with the card can trigger loyalty activity
The payment card is linked to the member profile and can be recognised by Tyro on future transactions.
Verify that your system can receive and process NEW_REGISTERED_CARD notifications.
For on-terminal loyalty, this event may contain pre-accumulated points associated with the payment card before registration.
- Use a payment card that has accumulated pre-registration loyalty activity
- Register the member using the Loyalty API
- Receive the NEW_REGISTERED_CARD notification
- Your webhook endpoint receives the notification
- The notification is processed successfully
- Any pre-accumulated point information is handled correctly by your system
Your system successfully receives and processes the NEW_REGISTERED_CARD notification.
Verify that Tyro sends loyalty activity notifications when a registered payment card is used in a transaction.
- Use a registered payment card to complete a transaction
- Ensure the merchant location has completed merchant activation
- Tyro sends a loyalty notification to your webhook endpoint
- Your webhook endpoint receives the loyalty notification
- The notification contains the transaction information required by your integration
- Your system can safely process repeated notifications
Your system receives the loyalty notification for the registered transaction.
Verify that customers can register through the on-terminal loyalty experience.
- Complete a transaction using an unregistered payment card
- Display the loyalty sign-up QR code on the terminal
- Complete registration using the QR code flow
- The QR code is displayed on the terminal
- The sign-up flow opens successfully
- The memberReference value is passed through the registration flow
- The payment card is linked after registration
The customer successfully registers through the terminal-led sign-up flow and the payment card is linked to their loyalty profile.
Verify that your system can receive and process merchant onboarding requests.
- Submit a merchant onboarding request
- Receive a NEW_ONBOARDING_REQUEST notification
- Retrieve the onboarding request details
- Submit an APPROVE or REJECT decision
- Your system receives the onboarding notification
- The onboarding request can be retrieved successfully
- Your decision is submitted successfully
- The merchant location becomes available for loyalty activity after approval
Your system successfully supports the merchant activation flow.
Verify that a payment card can be removed from a loyalty member profile.
- Deregister a linked payment card
- Attempt a transaction using the deregistered card
- The deregistration request succeeds
- The payment card is no longer linked to the member
- Transactions using the deregistered card no longer trigger loyalty activity
The deregistered payment card no longer generates loyalty activity.
Verify that a loyalty member can be removed from the loyalty program.
- Deregister the loyalty member
- Attempt transactions using previously linked payment cards
- The member deregistration request succeeds
- Linked payment cards are no longer associated with the member
- Loyalty activity is no longer generated for that member
The loyalty member is successfully removed from the program and no longer participates in loyalty activity.
Your integration should safely handle:
- Repeated notifications
- Invalid or expired member references
- Deregistered payment cards
- Merchant locations that have not completed activation
- Temporary webhook delivery failures