Skip to main content

How to provide Wallet Balance

The loyalty provider must return the customer’s available balance, in the form of loyalty points or wallet cash.

Updated over 2 weeks ago

GET Loyalty Customer wallet. It retrieves the loyalty points and cash amount for a customer .

Loyalty points are consumed when programs are applied, and cash is applied at checkout when the wallet is used. Cash wallet support is optional.

Get Customer Wallet

The loyalty provider must return the customer’s available balance, including loyalty points and, optionally, cash. This enables Deliverect Direct channels and Kiosk, as well as external partners, to display the customer’s current funds so they can decide how to use their rewards.

Example Response for the GET Customer wallet endpoint

{   
"points": {
"balance": 150,
"expirations": [
{
"amount": 500,
"date": "2030-01-01"
}
]
},
"cash": {
"balanceAmount": 1000,
"expirations": [
{ "amount": 150,
"date": "2030-01-01"
}
]
}
}

Wallet Points

Deliverect will provide an Online Ordering or a Kiosk test store to test the loyalty workflow with the loyalty provider platform. In this setup, the value of points.balance will be displayed as shown below.

Deliverect direct

Kiosk





Wallet Cash

The amount displayed at "Use Credits" level will reflect the cash.balanceAmount sent on the cash response.

Deliverect Direct

Deliverect Kiosk

Get Wallet Balance Response

{
"points": {
"balance": 150,
"expirations": [
{
"amount": 500,
"date": "2030-01-01"
}
]
},
"cash": {
"balanceAmount": 1000,
"expirations": [
{
"amount": 150,
"date": "2030-01-01"
}
]
}
}
Did this answer your question?