Wallet
Mobile Wallet API — Endpoints
Complete endpoint reference for the Mobile Wallet API. 28 endpoints across 8 groups.
Base URLs:https://mobileportal.helixapi.com https://uat.mobileportalapi.helixapi.com (UAT)
Admin (5)Admin access token (1)Apple and Google Wallets (4)Cards (10)Guests (4)Promotion (2)Quick Reloads (1)Sales (1)
Get Access Token needed for non Admin APIs authorization
Request Body
| Field | Type | Req | Description |
|---|---|---|---|
| username | string | ✓ | User name |
| password | string | ✓ | Password |
Responses
200Login successful
{
"access_token": "string",
"expires_in": 0,
"refresh_expires_in": 0,
"refresh_token": "string",
"token_type": "string",
"id_token": "string"
}
400Bad request
401Request is unauthorized
This API is to get the new Cognito access token using Cognito refresh token
Request Body
| Field | Type | Req | Description |
|---|---|---|---|
| refresh_token | string | ✓ | Refresh token |
Responses
200Token refresh successful
{
"access_token": "string",
"expires_in": 0,
"refresh_expires_in": 0,
"refresh_token": "string",
"token_type": "string",
"id_token": "string"
}
400Bad request
401Request is unauthorized
Registration of new guest
Request Body
| Field | Type | Req | Description |
|---|---|---|---|
| birth_date | string | ✓ | Birth Date of the Guest (format: yyyy-MM-dd) |
| card_bar_code | string | ✓ | Bar code of the card |
| card_cvv | string | ✓ | CVV of the Card |
| string | ✓ | Email Id of the Guest | |
| family_name | string | Family Name / Last Name of the Guest | |
| given_name | string | ✓ | Given Name / First Name of the Guest |
| marketing_checkbox | boolean | ✓ | Marketing Checkbox Selection by the Guest |
| password | string | ✓ | Password of the Guest |
| phone_number | string | Phone / Mobile Number of the Guest | |
| postal_code | string | Postal Code of the Guest | |
| title | string | ✓ | Title of the Guest |
| home_location_id | string | Home Store Location Id of the Guest |
Responses
201Signup successful
400Bad request
401Request is unauthorized
Trigger password reset for a guest login. An email will be sent to the guest’s email by Cognito containing the confirmation code that is required to change the guest’s password
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| emailAddress | path | string | ✓ |
Responses
204Password reset triggered
400Bad request
401Request is unauthorized
Confirm the password reset for the guest login. The confirmation code is the one sent by Cognito from the Trigger Reset Guest Password API
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| emailAddress | path | string | ✓ |
Request Body
| Field | Type | Req | Description |
|---|---|---|---|
| confirmation_code | string | ✓ | 6 digit confirmation code for the reset. Sent by Cognito via the Trigger Reset Guest Password API |
| new_password | string | ✓ | The new password to set |
Responses
204Password reset successful
400Bad request
401Request is unauthorized
Get Access Token needed for Admin APIs authorization
Request Body
| Field | Type | Req | Description |
|---|---|---|---|
| client_secret | string | ✓ | Client secret |
Responses
200Success
{
"access_token": "string",
"expires_in": 0,
"refresh_expires_in": 0,
"refresh_token": "string",
"token_type": "string",
"id_token": "string"
}
400Bad request
Disable a card in Apple Wallet and Google Pay
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| brand_id | query | string | ||
| operator_id | query | string | ||
| cardNumber | path | string | ✓ |
Responses
200Card is disabled in Apple Wallet and Google Pay
{
"apple_wallet": {
"status": "Success",
"message": "string"
},
"google_wallet": {
"status": "Success",
"message": "string"
}
}
400Bad request
401Request is unauthorized
Get the signed zip for Apple Pass
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| cardNumber | path | string | ✓ |
Responses
200Apple Pass created
400Bad request
401Request is unauthorized
Get the JWT token for Google Pay Pass
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| cardNumber | path | string | ✓ |
Responses
200Get The JWT Token for Google Pay Pass
400Bad request
401Request is unauthorized
Create Google Pay Pass Loyalty Class
Responses
201Create Google Pay Pass Loyalty Class
401Request is unauthorized
Get all the embed cards associated with the guest
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| size | query | integer | ||
| sort | query | string | ||
| page | query | integer |
Responses
200Success
{
"last": true,
"total_pages": 0,
"total_elements": 0,
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
},
"number_of_elements": 0,
"first": true,
"size": 0,
"number": 0,
"empty": true,
"pageable": {
"page_number": 0,
"page_size": 0,
"offset": 0,
"unpaged": true,
"paged": true,
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
}
},
"content": [
{
"card_number": "string",
"bar_code": "string",
"nick_name": "string",
"created_by": "string",
"created_date": "string",
"last_modified_by": "string",
"last_modified_date": "string",
"balance": {
"apple_wallet": true,
"bonus_balance": 0,
"card_number": "string",
"card_state": "string",
"card_type": "string",
"cash_balance": 0,
"cumulative_balance": 0,
"daily_free_games": 0,
"e_cash": 0,
"e_tickets": 0,
"free_games": 0,
"google_pay": true,
"last_modified_date": "2024-01-15T10:30:00Z",
"p_cash": 0,
"recycle_timestamp": "2024-01-15T10:30:00Z",
"running_cumulative_balance": 0
},
"activity": [
{
"card_number": "string",
"bonus_balance": 0,
"cash_balance": 0,
"cumulative_balance": 0,
"running_cumulative_balance": 0,
"p_cash": 0,
"e_cash": 0,
"e_tickets": 0,
"daily_free_games": 0,
"free_games": 0,
"apple_wallet": true,
"google_pay": true,
"last_modified_date": "2024-01-15T10:30:00Z",
"card_state": "string",
"date_time": "2024-01-15T10:30:00Z",
"reason": "string",
"description": "string",
"reference_id": "string",
"parent_id": "string",
"location_name": "string",
"reissued_to_card_barcode": "string",
"reissued_from_card_barcode": "string"
}
]
}
]
}
400Bad request
401Request is unauthorized
Associate a new card with the guest
Request Body
| Field | Type | Req | Description |
|---|---|---|---|
| bar_code | string | ✓ | Barcode of the card |
| cvv | string | ✓ | CVV / CVC of the card |
| nick_name | string | Nick Name of the card |
Responses
201New card is associated
{
"card_number": "string"
}
400Bad request
401Request is unauthorized
Update the nickname of a card
Request Body
| Field | Type | Req | Description |
|---|---|---|---|
| card_number | string | ✓ | 19 digit full Card Number |
| nick_name | string | Nickname of the card |
Responses
204Nickname is updated
{
"card_number": "0012086890100008729",
"nick_name": "VIP Card"
}
400Bad request
401Request is unauthorized
Get card details, balance and activity using full card number of the guest
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| cardNumber | path | string | ✓ |
Responses
200Success
{
"card_number": "string",
"bar_code": "string",
"nick_name": "string",
"created_by": "string",
"created_date": "string",
"last_modified_by": "string",
"last_modified_date": "string",
"balance": {
"apple_wallet": true,
"bonus_balance": 0,
"card_number": "string",
"card_state": "string",
"card_type": "string",
"cash_balance": 0,
"cumulative_balance": 0,
"daily_free_games": 0,
"e_cash": 0,
"e_tickets": 0,
"free_games": 0,
"google_pay": true,
"last_modified_date": "2024-01-15T10:30:00Z",
"p_cash": 0,
"recycle_timestamp": "2024-01-15T10:30:00Z",
"running_cumulative_balance": 0
},
"activity": [
{
"card_number": "string",
"bonus_balance": 0,
"cash_balance": 0,
"cumulative_balance": 0,
"running_cumulative_balance": 0,
"p_cash": 0,
"e_cash": 0,
"e_tickets": 0,
"daily_free_games": 0,
"free_games": 0,
"apple_wallet": true,
"google_pay": true,
"last_modified_date": "2024-01-15T10:30:00Z",
"card_state": "string",
"date_time": "2024-01-15T10:30:00Z",
"reason": "string",
"description": "string",
"reference_id": "string",
"parent_id": "string",
"location_name": "string",
"reissued_to_card_barcode": "string",
"reissued_from_card_barcode": "string"
}
]
}
400Bad request
401Request is unauthorized
Un-register the card from the guest
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| cardNumber | path | string | ✓ |
Responses
204Card is un-registered from the guest
400Bad request
401Request is unauthorized
Get latest balance on the guest card
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| cardNumber | path | string | ✓ | |
| brand_id | query | string |
Responses
200Success
{
"apple_wallet": true,
"bonus_balance": 0,
"card_number": "string",
"card_state": "string",
"card_type": "string",
"cash_balance": 0,
"cumulative_balance": 0,
"daily_free_games": 0,
"e_cash": 0,
"e_tickets": 0,
"free_games": 0,
"google_pay": true,
"last_modified_date": "2024-01-15T10:30:00Z",
"p_cash": 0,
"recycle_timestamp": "2024-01-15T10:30:00Z",
"running_cumulative_balance": 0
}
400Bad request
401Request is unauthorized
404Not Found
409Conflict
Check if a card is available and is not linked to other guest
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| card_bar_code | query | string | ||
| card_cvv | query | string | ||
| domain | query | string |
Responses
200Card is available
{
"card_availability": "Available"
}
400Bad request
Recent activities of the guest card
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| brand_id | query | string | ||
| cardNumber | path | string | ✓ |
Responses
200Success
[
{
"card_number": "string",
"bonus_balance": 0,
"cash_balance": 0,
"cumulative_balance": 0,
"running_cumulative_balance": 0,
"p_cash": 0,
"e_cash": 0,
"e_tickets": 0,
"daily_free_games": 0,
"free_games": 0,
"apple_wallet": true,
"google_pay": true,
"last_modified_date": "2024-01-15T10:30:00Z",
"card_state": "string",
"date_time": "2024-01-15T10:30:00Z",
"reason": "string",
"description": "string",
"reference_id": "string",
"parent_id": "string",
"location_name": "string",
"reissued_to_card_barcode": "string",
"reissued_from_card_barcode": "string"
}
]
400Bad request
401Request is unauthorized
Toggle the card state between Active and Suspended
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| cardNumber | path | string | ✓ |
Responses
204Card state change complete
400Bad request
401Request is unauthorized
409Card has Disabled state
Un-register and Disable The Card in Apple Wallet and Google Pay
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| brand_id | query | string | ||
| operator_id | query | string | ||
| cardNumber | path | string | ✓ |
Responses
204Card is un-registered from the guest and disabled in Apple Wallet and Google Pay
400Bad request
401Request is unauthorized
Get guest's account details
Responses
200Success
{
"birthDate": "2024-01-15T10:30:00Z",
"country": "string",
"createdBy": "string",
"createdDate": "2024-01-15T10:30:00Z",
"customerId": "string",
"customerName": "string",
"email": "string",
"emailVerified": true,
"familyName": "string",
"givenName": "string",
"id": "string",
"lastModifiedBy": "string",
"lastModifiedDate": "2024-01-15T10:30:00Z",
"marketingCheckbox": "string",
"operatorId": "string",
"phoneNumber": "string",
"phoneNumberVerified": true,
"postalCode": "string",
"registeredDateTime": "2024-01-15T10:30:00Z",
"title": "string",
"homeLocationId": "string",
"homeLocationName": "string",
"walletLanguageCode": "string"
}
401Request is unauthorized
Update the guest's account details
Request Body
| Field | Type | Req | Description |
|---|---|---|---|
| birth_date | string | Birth Date of the Guest | |
| string | Email Id of the Guest | ||
| family_name | string | Family Name / Last Name of the Guest | |
| given_name | string | Given Name / First Name of the Guest | |
| phone_number | string | Phone / Mobile Number of the Guest | |
| postal_code | string | Postal Code of the Guest | |
| home_location_id | string | Home Store Location Id of the Guest | |
| rsp_code | string | Registration code provided by the staff member assisting with your card registration | |
| auth_type | string | Internal | |
| wallet_language_code | string | Mobile wallet content language preference | |
| marketing_consent | boolean | Marketing consent preference | |
| isEmpty | boolean |
Responses
204Success
400Bad request
401Request is unauthorized
Change the guest’s login password
Request Body
| Field | Type | Req | Description |
|---|---|---|---|
| previous_password | string | ✓ | Previous password |
| proposed_password | string | ✓ | Proposed password |
Responses
204Success
400Bad request
401Request is unauthorized
Sign out guest
Responses
204Success
401Request is unauthorized
Get promotions for guest
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| size | query | integer | ||
| sort | query | string | ||
| page | query | integer |
Responses
200Success
{
"last": true,
"total_pages": 0,
"total_elements": 0,
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
},
"number_of_elements": 0,
"first": true,
"size": 0,
"number": 0,
"empty": true,
"pageable": {
"page_number": 0,
"page_size": 0,
"offset": 0,
"unpaged": true,
"paged": true,
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
}
},
"content": [
{
"id": "string",
"created_date": "string",
"last_modified_date": "string",
"created_by": "string",
"last_modified_by": "string",
"promotion_names": [
{
"created_date": "string",
"last_modified_date": "string",
"created_by": "string",
"last_modified_by": "string",
"id": "string",
"name": "string",
"language_code": "string",
"language_code_iso": "string"
}
],
"operator_id": "string",
"bonus_balance": 0,
"e_tickets": 0,
"topup_balance_to": "string",
"active": true,
"deleted": true,
"card_limit": 0
}
]
}
400Bad request
401Request is unauthorized
Apply a promotion to a guest card
Request Body
| Field | Type | Req | Description |
|---|---|---|---|
| card_number | string | ✓ | 19 digit full Card Number |
| promotion_id | string | Promotion identifier |
Responses
200Ok
{
"promotion_transaction_id": "string"
}
400Bad request
401Request is unauthorized
Get quick reloads for guest
Parameters
| Name | In | Type | Req | Description |
|---|---|---|---|---|
| size | query | integer | ||
| sort | query | string | ||
| page | query | integer |
Responses
200Success
{
"last": true,
"total_pages": 0,
"total_elements": 0,
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
},
"number_of_elements": 0,
"first": true,
"size": 0,
"number": 0,
"empty": true,
"pageable": {
"page_number": 0,
"page_size": 0,
"offset": 0,
"unpaged": true,
"paged": true,
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
}
},
"content": [
{
"id": "string",
"created_date": "string",
"last_modified_date": "string",
"created_by": "string",
"last_modified_by": "string",
"product_names": [
{
"created_date": "string",
"last_modified_date": "string",
"created_by": "string",
"last_modified_by": "string",
"id": "string",
"name": "string",
"language_code": "string",
"language_code_iso": "string"
}
],
"operator_id": "string",
"cash_balance": 0,
"bonus_balance": 0,
"bonus_percentage": 0,
"min_reload_amount": 0,
"max_reload_amount": 0,
"any_amount": true,
"e_tickets": 0,
"amount": 0,
"amount_includes_tax": true,
"tax_percentage": 0,
"topup_balance_to": "string",
"display_order": 0,
"active": true,
"deleted": true
}
]
}
400Bad request
401Request is unauthorized
Record a successful online sale transaction on the card
Request Body
| Field | Type | Req | Description |
|---|---|---|---|
| card_barcode | string | ✓ | 8 or 10 digit barcode printed on the card |
| product_id | string | ✓ | Product id |
| transaction_id | string | ✓ | Payment transaction id |
| payment_provider_name | string | ✓ | Payment provider name |
| qty_sold | integer | ✓ | Quantity sold |
| date | string | ✓ | Transaction date time |
| amount | number | Amount |
Responses
200Record created
{
"id": "string",
"message": "string"
}
400Bad request
401Request is unauthorized