Loyalty Integration Use Cases

Data

 

Use Cases

Use Case 1

1. Customer buys:

2. Customer pays 13$ in cash

/transaction/loyalty/credit/multi

 

JSON request payload:

{
 "device_id": "0d373af2942291bf",
 "cardnumber": "612573981949778930",
 "clerk_id": "",
 "ackroo_id": "",
 "price_list": ["5","3"],
 "quantity_list": ["2","1"],
 "dept_id_list": ["02","01"],
 "sku_id_list": ["0103","0104"],
 "tender_type_list": ["13","0","0","0","0"],
 "promo_id_list":[]
 } 

3. Ackroo rewards 1.3$

 

 

Use Case 2

1. Customer buys:

2. Customer pays 13$ in cash

/transaction/loyalty/credit/multi

 

JSON request payload:

{
 "device_id": "0d373af2942291bf",
 "cardnumber": "612573981949778930",
 "clerk_id": "",
 "ackroo_id": "",
 "price_list": ["5","3"],
 "quantity_list": ["2","2"],
 "dept_id_list": ["02","01"],
 "sku_id_list": ["0103","0104" ],
 "tender_type_list": ["13","0","0","0","0"],
 "promo_id_list": [] 
} 

3. Ackroo rewards 1.6$

 

 

Use Case 3

1. Customer buys:

2. Customer pays 10$ in cash

/transaction/loyalty/credit/multi

 

JSON request payload:

{
 "device_id": "0d373af2942291bf",
 "cardnumber": "612573981949778930",
 "clerk_id": "",
 "ackroo_id": "",
 "price_list": ["2","4"],
 "quantity_list": ["1","2"],
 "dept_id_list": ["01","02"],
 "sku_id_list": ["0101","0102"],
 "tender_type_list": ["8","0","0","0","0"],
 "promo_id_list": []
} 

3. Ackroo rewards 2.0$

 

 

Use Case 4

1. Customer buys:

2. Customer pays 20$ in cash

/transaction/loyalty/credit/multi

 

JSON request payload:

{
 "device_id": "0d373af2942291bf",
 "cardnumber": "612573981949778930",
 "clerk_id": "",
 "ackroo_id": "",
 "price_list": ["2","4","5"],
 "quantity_list": ["1","2",“2”],
 "dept_id_list": ["01","02","02"],
 "sku_id_list": ["0101","0102","0103"],
 "tender_type_list": ["20","0","0","0","0"],
 "promo_id_list": [] 
} 

 3. Ackroo rewards 3.0$

 

 

Use Case 5

1. Customer buys:

2. Customer pays 27$ in cash

/transaction/loyalty/credit/multi

 

JSON request payload:

{
 "device_id": "0d373af2942291bf",
 "cardnumber": "612573981949778930",
 "clerk_id": "",
 "ackroo_id": "",
 "price_list": ["2","4","5","7"],
 "quantity_list": ["1","2",“2”,"7"],
 "dept_id_list": ["01","02","02","03" ],
 "sku_id_list": ["0101","0102","0103","0105"],
 "tender_type_list": ["27","0","0","0","0"],
 "promo_id_list": [] 
} 

3. Ackroo rewards 5.8$

 

 

Use Case 6

1. Customer buys:

2. Customer pays 27$ in debit

/transaction/loyalty/credit/multi

 

JSON request payload:

 

{
 "device_id": "0d373af2942291bf",
 "cardnumber": "612573981949778930",
 "clerk_id": "",
 "ackroo_id": "",
 "price_list": ["2","4","5","7"],
 "quantity_list": ["1","2",“2”,"7"],
 "dept_id_list": ["01","02","02","03" ],
 "sku_id_list": ["0101","0102","0103","0105"],
 "tender_type_list": ["0","27","0","0","0"],
 "promo_id_list": [] 
} 

3. Ackroo rewards 2.9$

 

 

Use Case 7

1. Customer buys:

2. Customer pays 7$ in cash and 20$ in debit

/transaction/loyalty/credit/multi

 

JSON request payload:

{
 "device_id": "0d373af2942291bf",
 "cardnumber": "612573981949778930",
 "clerk_id": "",
 "ackroo_id": "",
 "price_list": ["2","4","5","7"],
 "quantity_list": ["1","2",“2”,"7"],
 "dept_id_list": ["01","02","02","03" ],
 "sku_id_list": ["0101","0102","0103","0105"],
 "tender_type_list": ["7","20","0","0","0"],
 "promo_id_list": [] 
} 

3. Ackroo rewards 3.65$

 

 

Use Case 8

1. Customer buys:

2. Customer pays 13$ in cash

/transaction/loyalty/credit/multi

 

JSON request payload:

{
 "device_id": "0d373af2942291bf",
 "cardnumber": "612573981949778930",
 "clerk_id": "",
 "ackroo_id": "",
 "price_list": ["5","3"],
 "quantity_list": ["2","1"],
 "dept_id_list": ["02","01"],
 "sku_id_list": ["0103","0104" ],
 "tender_type_list": ["13","0","0","0","0"],
 "promo_id_list": []
} 

3. Ackroo rewards 1.3$
4. Customer returns the bagels

/transaction/loyalty/refund/multi

 

{
 "device_id": "0d373af2942291bf",
 "cardnumber": "612573981949778930",
 "clerk_id": "",
 "ackroo_id": "",
 "price_list": ["5"],
 "quantity_list": ["2"],
 "dept_id_list": ["02"],
 "sku_id_list": ["0103"],
 "tender_type_list": ["10","0","0","0","0"],
 "promo_id_list": []
} 

5. Ackroo debits 1.0$

 

 

 

Use Case 9

1. Customer spends 10$ at the store and wants to redeem loyalty (balance less than 10$ total earned loyalty):

/device/card returns outstanding earned loyalty balance el_balance

/transaction/loyalty/debit/partial redeems loyalty as partial payment

 

JSON request payload:

{
 "device_id": "0d373af2942291bf",
 "cardnumber": "612573981949778930",
 "clerk_id": "",
 "ackroo_id": "",
 "amount”: “10”
}

2. Ackroo debits total earned loyalty balance amount returned on check balance el_balance in Step 1, new loyalty balance is zero.

 

 

Use Case 10

1. Customer loads gift card in store with 10$

/device/card returns outstanding gift balance gc_balance

/transaction/gift/credit loads gift card

 

JSON request payload:

{
 "device_id": "0d373af2942291bf",
 "cardnumber": "612573981949778930",
 "clerk_id": "",
 "ackroo_id": "",
 "amount”: “10”
}

2. Ackroo loads gift card and new gift balance returned is gc_balance  + 10

 

 

 

Use Case 11

1. Customer spends 50$ at the store and wants to redeem gift (gift balance is less than 50$):

/device/card returns outstanding gift balance gc_balance

/transaction/gift/debit/partial redeems gift as partial payment

 

JSON request payload:

{
 "device_id": "0d373af2942291bf",
 "cardnumber": "612573981949778930",
 "clerk_id": "",
 "ackroo_id": "",
 "amount”: “50”
}

2. Ackroo debits total gift balance amount returned on check balance gc_balance in Step 1, new gift balance is 0

 

 

Use Case 12

1. Customer loads gift card in store with 10$

/device/card returns outstanding gift balance gc_balance

/transaction/gift/credit loads gift card

 

JSON request payload:

{
 "device_id": "0d373af2942291bf",
 "cardnumber": "612573981949778930",
 "clerk_id": "",
 "ackroo_id": "",
 "amount”: “10”
}

2. Ackroo loads gift card and new gift balance returned is gc_balance  + 10, transaction number returned is txn_id

3. Merchant decides to reverse the gift load transaction

/transaction/reversal reverses the transaction by txn_id

 

JSON request payload:

{
 "device_id": "0d373af2942291bf",
 "transaction_number": “txn_id ",
 "clerk_id": ""
}

4. Ackroo reverses the transaction for txn_id, returns new balance which has the gift fund amount reversed, new balance equals the original gc_balance 

 

 

Use Case 13

1. Customer checks balance in store

/device/card returns outstanding gift, earned loyalty, and promo balance

 

JSON request payload:

{
 "device_id": "0d373af2942291bf",
 "cardnumber": "612573981949778930"
}

2. Ackroo returns gift balance, total loyalty balance, and the breakdown of total loyalty which is earned and promotion balances to be displayed on receipt or POS

 

 

Use Case 14

1. Customer presents a loyalty card that has a magstripe on the back

2. Merchant runs a check balance and swipes the card with magstripe reader

3. Ackroo returns valid value for balance

 

 

Use Case 15

1. Customer presents a loyalty card that has a barcode on the back

2. Merchant runs a check balance and scans the card with barcode reader

3. Ackroo returns valid value for balance

 

 

Use Case 16

1. Customer presents a loyalty card that has a magstripe on the back

2. Merchant runs a check balance and swipes the card with magstripe reader

3. Ackroo returns valid value for balance

 

 

Use Case 17

1. Customer presents a loyalty card that has a QR code on the front

2. Merchant runs a check balance and scans the card with a QR reader

3. Ackroo returns valid value for balance

 

 

Use Case 18

1. Customer presents a loyalty card that has a QR code on the back

2. Merchant runs a check balance and scans the card with a QR reader

3. Ackroo returns valid value for balance

 

 

Use Case 19

1. Customer presents a mobile app virtual card that has a QR code on it (QR paper print out from the mobile app)

2. Merchant runs a check balance and scans the card with a QR reader

3. Ackroo returns valid value for balance