This guide will be removed on April 29, 2022. Please use our new, easier-to-use Toast technical documentation site. All updated content is on the new site.

Loyalty integration test plan

You can use this test plan while you build your gift card integration. Your integration should be able to successfully complete all cases in this plan before it goes live.

You should also ensure that your integration successfully authenticates the JSON objects that you receive.

You can download a CSV version of this test plan.

Case number

Category

Test case

Steps

Expected results

1

Account Lookup

Card swipe

From the Toast POS app > New Order.

Tap Rewards > Look Up Customer.

Swipe a card associated with a loyalty account at that restaurant.

The expected loyalty account should appear.

2

Account Lookup

Card swipe

From the Toast POS app > New Order.

Tap Rewards > Look Up Customer.

Swipe a card NOT associated with a loyalty account at that restaurant.

The Invalid Account error message should appear.

3

Account Lookup

Card swipe

From the Toast POS app > New Order.

Tap Rewards > Look Up Customer.

Swipe a card that is NOT a loyalty account card.

The Card swiped is not a rewards card error message should appear.

4

Account Lookup

Keying in number

From the Toast POS app > New Order.

Tap Rewards > Look Up Customer.

Key in a card number associated with a loyalty account at that restaurant.

The expected loyalty account should appear.

5

Account Lookup

Scanning QR code

From the Toast POS app > New Order.

Tap Rewards > Look Up Customer > Scan.

Scan a QR code associated with a loyalty account at that restaurant.

The expected loyalty account should appear.

6

Account Lookup

Scanning QR code

From the Toast POS app > New Order.

Tap Rewards > Look Up Customer > Scan.

Scan a QR code NOT associated with a loyalty account at that restaurant.

The Invalid Account error message should appear.

7

Account Lookup

By email

From the Toast POS app > New Order.

Tap Rewards > Look Up Customer > Lookup.

Key in an email address associated with a loyalty account at that restaurant.

The expected loyalty account should appear.

8

Account Lookup

By phone number

From the Toast POS app > New Order.

Tap Rewards > Look Up Customer > Lookup.

Key in a phone number associated with a loyalty account at that restaurant.

The expected loyalty account should appear.

9

Account Lookup

By name

From the Toast POS app > New Order.

Tap Rewards > Look Up Customer > Lookup.

Key in a name associated with a loyalty account at that restaurant.

The expected loyalty account should appear.

10

Account Inquiry

Unavailable rewards

From the Toast POS app > New Order.

Tap Rewards > Look Up Customer.

Look up a loyalty account that has associated rewards.

The expected rewards value should display, but because the awards are unavailable for redemption, you should not be able to apply them to a check.

11

Account Inquiry

Available rewards

From the Toast POS app > New Order.

Tap Rewards > Look Up Customer.

Look up a loyalty account that has associated rewards.

Add items that would trigger rewards to the check.

Tap Rewards > Look Up Customer.

The expected rewards should be available redemption.

A Redeem button should be present.

12

Account Inquiry

Rewards points

From the Toast POS app > New Order.

Tap Rewards > Look Up Customer.

Look up a loyalty account that has associated rewards.

The expected rewards value should display on the dialog.

13

Account Inquiry

Invalidated rewards

From the Toast POS app > New Order.

Tap Rewards > Look Up Customer.

Look up a loyalty account that has associated rewards.

Add items that would trigger rewards to the check.

Tap Rewards > Look Up Customer.

Remove the items from your check.

Tap Rewards > Look Up Customer.

The reward should be removed from the check.

The error message Changes to the check have voided applied rewards. Discounts that are no longer applicable have been removed should display.

14

Redemption

Item-level discount

From the Toast POS app > New Order.

Tap Rewards > Look Up Customer.

Look up a loyalty account that has associated rewards.

Add items that would trigger rewards to the check.

Tap Rewards > Look Up Customer.

Tap Redeem to add a reward to the check.

The reward should apply to the target item on the check.

The amount discounted should be correct.

15

Redemption

Item-level discount

Tap Pay.

The reward discount should be correctly carried to the payment screen.

16

Redemption

Item-level discount

Complete payment on the check.

The payment should process successfully.

17

Redemption

Check-level discount

From the Toast POS app > New Order.

Tap Rewards > Look Up Customer.

Look up a loyalty account that has associated rewards.

Add items that would trigger rewards to the check.

Tap Rewards > Look Up Customer.

Tap Redeem to add a reward to the check.

The reward should apply to the check.

The amount discounted should be correct.

18

Redemption

Check-level discount

Tap Pay.

The reward discount should be correctly carried to the payment screen.

19

Redemption

Check-level discount

Complete payment on the check.

The payment should process successfully.

20

Redemption

Buy one get one discount

From the Toast POS app > New Order.

Tap Rewards > Look Up Customer.

Look up a loyalty account that has associated rewards.

Add items that would trigger rewards to the check.

Tap Rewards > Look Up Customer.

The expected reward should display, but should be unavailable for redemption.

21

Redemption

Buy one get one discount

Add items that would trigger rewards to the check.

Tap Rewards > Look Up Customer.

The expected rewards should be available redemption.

A Redeem button should be present.

22

Redemption

Buy one get one discount

Tap Redeem to add a reward to the check.

The reward should apply to the target item on the check.

The amount discounted should be correct.

23

Redemption

Buy one get one discount

Tap Pay.

The reward discount should be correctly carried to the payment screen.

24

Redemption

Buy one get one discount

Complete payment on the check.

The payment should process successfully.

25

Accrual and Reversal

Without reward applied to check

From the Toast POS app > New Order.

Tap Rewards > Look Up Customer.

Look up a loyalty account that has associated rewards.

Add items to the check.

Tap Pay($).

The payment should process successfully.

You should see the expected accrual message.

26

Accrual and Reversal

Accrual reverse

On the Closed Checks tab, find the order placed in case 25.

Tap Pay($).

Void all payments.

In the overflow menu, clock Void Order.

Confirm the void operation.

The check should be successfully voided in Toast.

You should see the expected reversal message.

27

Accrual and Reversal

With reward applied to check

From the Toast POS app > New Order.

Tap Rewards > Look Up Customer.

Look up a loyalty account that has associated rewards.

Add items that would trigger rewards to the check.

Tap Rewards > Look Up Customer.

Tap Redeem to add a reward to the check.

Tap Pay.

Complete payment on the check.

The payment should process successfully.

You should see the expected accrual and redeem messages.

28

Accrual and Reversal

Redemption reverse

On the Closed Checks tab, find the order placed in case 27.

Tap Pay($).

Void all payments.

In the overflow menu, click Void Order.

Confirm the void operation.

The check should be successfully voided in Toast,.

You should see the expected reversal messages.

29

Accrual and Reversal

With multiple rewards applied to check

From the Toast POS app > New Order.

Tap Rewards > Look Up Customer.

Look up a loyalty account that has associated rewards.

Add items that would trigger rewards to the check.

Tap Rewards > Look Up Customer.

Tap Redeem to add a reward to the check.

Repeat at least once in order to apply multiple rewards to the check.

Tap Pay.

Complete payment on the check.

The payment should process successfully.

You should see the expected accrual and redeem messages.

30

Accrual and Reversal

Partial redemption reverse

On the Closed Checks tab, find the order placed in case 29.

Tap Update.

Select a reward that was redeemed, and void it from the check.

Tap Pay.

Complete payment on the check.

The check should successfully close.

You should see the expected reversal messages.