Multi-accounts

Owned by Tibor Tasi
Last updated: Feb 16, 2024 by Klári Németh
8 min read

The Multi-accounts module allows the maintenance of multiple loyalty program accounts. This tool manages all of a registered user’s accounts created within the Antavo database. Multiple accounts can be used with Antavo’s functionalities seamlessly by having the possibility to select the account to handle the points related to the specific customer action.

The Multi-accounts module integrates the mechanisms and configuration interfaces of various purchase-related modules, namely the Incentivized Purchase, Burn rules, Checkout accept, and Expiring points modules.

Find the configuration page of the Multi-account module by clicking on the icon in the sidebar and searching for the Multi-accounts item on the Modules list. In case the Points economy module is enabled in your brand, you can also click the icon on the sidebar to open the module configuration page. Either way, the page will open to the list of accounts that are already set up with the following information:

  • Unique ID - a unique ID that distinguishes this account from any other user account
    A text label, immediately below the unique ID, specifies if the account is Active or Inactive.

  • Name - name assigned to the account when it was created

  • Currency label - currency acronym indicates which currency this account is to be used for - eg. EUR, USD, or HUF

  • Family account - a ‘Yes’ or ‘No’ text field confirms whether this is a family account
    A family account groups two or more customers together to form an affiliate account so that they can pool their resources.

Configuring Multi-accounts

Create a new account

By clicking ‘Create new account’ in the module sidebar, you can start setting up a new account. All of the configuration fields and criteria for each are detailed in the section below.

Basic settings 

The Basic settings screen provides the following configuration fields:

  • Unique ID
    A mandatory field, a unique ID that distinguishes this account from any other user account. You can enter lowercase characters, underscore (_), and numbers.

  • Name
    A mandatory field to store the human-readable name of the account. After creation, it will be displayed at the top left during account editing. Enter any text with mixed characters (string).
    To avoid confusion, the possibility to name an account as ‘default' is disabled. This prevents any potential mix-ups between a Default account created for this purpose and an account simply named 'default’.

  • Currency label
    A mandatory field, the currency acronym specifies the currency of the account - eg. EUR, USD, or HUF. You can enter any string that uniquely identifies one specific currency. We recommend using ISO 4217 codes.

  • Type
    The type of the account can either be a Standard or a Status Points account, which serves informative and administrative purposes only in the Backoffice.

    • Standard
      Refers to those accounts with standard points, earned through any customer actions that are rewarded with points in the loyalty program (eg. shopping, completing challenges, writing reviews).

    • Status Points
      Refers to those accounts with status points, earned by progressing in the Tier system (e.g., these points may come from checkouts in spend-based tiers or by earning points in points-based tiers). 

  • Negative points
    Tick the checkbox if you would like to let customers have a negative point balance by spending more points than the number of points currently available on their account.

  • Initialized upon opt-in
    If enabled, the account object will automatically be assigned to customers when they are registered in the loyalty program.

  • Access level

    • This option provides the opportunity to set up extra permissions in terms of functions and visibility. When left blank, the account will be visible to any platform user.

  • Click the ‘Create’ button to save your settings. The account will be saved with an ‘inactive’ status.

Earn rules

In case the Incentivized purchase module is turned on in your brand, the Earn rules tab appears that uses the configuration interface of the Incentivized Purchase module. You can learn more about the settings available here.

Burn rules

Under the Burns rules tab, you will find the configuration page of the Burn Rules module if it’s enabled in your loyalty program. Learn more about this module here.

Pending points

Setting up pending points adds an additional verification step between the submission of a checkout event and the subsequent point allocation. A Pending points tab that inherits the configuration interface of the Checkout accept module allows you to set up specific Checkout accept mechanism for all the accounts you add in the Multi-accounts module.

Expiration

If you use point expiration in your loyalty program, the configuration of the Expiring points module is integrated into the Expiration tab of the account editors, so that you can set up specific point expiration mechanisms for each of your accounts. Learn more about the configuration options here.
Please note that the ‘Expiration date for refunded points’ configuration option can be configured under Multi-account settings, it is not available on a per-account level.

Activate an account

As mentioned previously, first the account will be saved as ‘inactive’, which means the account won’t be available to customers and will appear only in the list of accounts on the Multi-accounts module configuration page.

After you have saved your new account, you can activate it right away using the ‘Set active’ button on the upper right-hand side of the reward setup page and confirm the activation in the dialog that subsequently appears.

This confirmation message displays after clicking
'Set active'.

If you don’t want to activate the account right after saving, you can always find the activation button on the account editor page.

Managing accounts

Search for a specific account

When there are several pages of accounts, instead of scrolling through each and every page, the ‘Type to search…’ field at the upper left corner can be used to search for a specific account(s).

  • Entering a string of text characters in the ‘Type to search…’ field
    Searching is only possible based on the unique ID or the account name values.

  • If necessary, click the ‘Accounts’ label at the top left corner to remove the search filter and redisplay all accounts

Edit an existing account

  • Go to the Multi-accounts page

  • Click the ‘Edit’ button of the account that you want to edit

  • Edit your account

  • Save your changes by clicking ‘Update’

This confirmation message displays after clicking
'Update'.

Deactivate an account

If you want to stop using an account, you can deactivate it anytime:

  • Go to the Multi-accounts page

  • Click the ‘Edit’ button of the account that you want to deactivate

  • Click on the ‘Set inactive’ button on the upper right-hand side of the page

  • Confirm your choice in the dialog that appears

 

This confirmation message displays after deactivating the account.

Archive an account

You have the option to delete an inactive account from the Backoffice by archiving it.

  • Go to the Multi-accounts page

  • Click on the inactive account you want to archive

  • Click on the ‘Archive’ button on the upper right-hand side of the page

  • Confirm your choice in the dialog that appears

Archiving is irreversible. Once an account is archived, it cannot be restored anymore.

 

This confirmation message displays after archiving the account.

Settings

Default account

The Settings tab provides a ‘Default account’ selector dropdown field, which is a mandatory setting.

Select the account you wish to set as the default account from the dropdown list.

The account that you create the first will automatically be set as the default account until you deliberately select one and click the ‘Update’ button on the Settings page.

If the default account has not been configured, a warning message reminds you to do so at the top of the Backoffice interface. Clicking the ‘Resolve’ button will open the Settings page of the Multi-accounts module where you can select the default account.


Once you have set a default account, it will be automatically selected on all Backoffice configuration interfaces that involve an account selector, if no other account has been selected previously on the dedicated configuration page.

Points will be credited to the selected default account in case the account value is empty in the API request, except for events that are connected to preceding events. These events inherit the account value of the previous event:

Preceding event

Events inheriting the account value

Preceding event

Events inheriting the account value

Draft transaction

Reserve

Checkout

Checkout

Refund, Refund item, Partial refund, Checkout update, Checkout accept, Checkout reject, Checkout claim

Reward

Reward revoke, Reward unbid

Campaign bonus

Campaign bonus revoke

Point spend

Point un-spend

Reserve

Release

Any event selected in the Action field of the Pending events module

Pending

If the account value is sent with any of these events, but it’s different from the account of the original event, the API will respond with an error.

Force account matching

By adding a point-burning entity - reward, prize wheel, contest - the event related to the entity (eg. Reward claim, Wheel spin, Promotion enter) must have the same account value as the entity account setting. If the account is different, the request will fail due to an account mismatch.
The dropdown field lists the point-burning entities that are available in your loyalty program if the relevant module is enabled (Rewards, Prize wheels, Contest lite and Quizzes).

To save your settings changes, please make sure you click the ‘Update’ button before leaving the page.

Keep the Checkout module settings

If you use the Checkout accept module, you can find the ‘Keep the Checkout module settings' checkbox. It allows enforcing the settings configured under the Checkout accept module. If this option is enabled, the account-specific configurations under the Pending points tab will lapse and be overridden by the settings of the Checkout accept module.

Expiration date for refunded points

This option is available in case you use the Expiring points module. Please learn more about the configurable options in the Expiring points user manual.

If the ‘Keep the original expiration date’ option is selected and a purchase is refunded, the expiration date of refunded points will remain the same as the expiration date of the originally assigned points. If the originally assigned points don't have an expiration date, a new expiration date will be calculated based on the current expiration settings.

Account selector fields on Backoffice interfaces

If the Multi-accounts module is enabled in your loyalty program, you will find a mandatory ‘Account’ configuration field on entity configuration pages of modules that are compatible with Multi-accounts. The selected account is where all the events related to the specific entity should be registered.
By default, the default account is selected.

As of now, the 'Account' field is available on the configuration interfaces of the following modules:

© Copyright 2022 Antavo Ltd.