Switching clients

If your business has sub-accounts, you can work in any of them from the Azupay Dashboard without signing in again. The account switcher moves you between your main account, its sub-accounts and any sub-accounts nested below those.

Your main account is the account you signed in to. You only see the accounts you're authorised to access.

📘

Before you start

Sub-accounts are created with the Clients API. See Creating sub-accounts and Account types and client management.

How accounts are organised

Accounts sit in a hierarchy. A sub-account can have its own sub-accounts, and those can have more below them.

For example, Example Group might have two sub-accounts, Example Retail and Example Online. Example Retail could then have a sub-account for each of its stores.

Every account shows two names. The trading name is on the first line and the legal entity name is on the second. These come from the tradingName and legalName values set when the account was created.

Open the account switcher

Select your initials in the top bar.

The top of the switcher shows your name and the account you're working in. Below that is the account list. It opens at the level that holds your current account, so you can see the accounts alongside it.

Your current account is marked in the list. If an account has sub-accounts, you'll see a number and an arrow next to it. The number tells you how many sub-accounts sit directly below it.

Switch to an account

  1. Open the account switcher.
  2. Select the account name. Don't select the arrow, as that opens the account's sub-accounts instead.

The switcher closes and the Dashboard header shows the account you picked. Its data loads and you stay signed in.

If the new account has access to the page you were on, you stay on that page. What you can see and do depends on that account's permissions and enabled features.

You can switch to any account in the list, whether or not it has sub-accounts of its own.

Browse sub-accounts

Browsing lets you look through the hierarchy without leaving the account you're working in.

  1. Select the arrow next to an account. The list changes to show its direct sub-accounts.
  2. Repeat to go further down.

To go back up:

  • Select Back to [parent account name] to go up one level.
  • Select an earlier level in the breadcrumb to jump straight to it. The last item shows where you are and can't be selected.
  • Select All accounts to return to the top level.

Going back up clears any search you've started.

Search for an account

Type in the search field to find an account by using a segment of its trading name, legal entity name or client identifier.

It will always search the through the entire hierarchy of clients under which your user was created but sometimes it will offfer the option to only filter a subsection of the tree based on your navigation position.

Each result shows the trading name first. The second line shows either the legal entity name or the account's path, which helps you tell similar names apart. You'll see the legal entity name when:

  • the legal entity name is what matched your search
  • the account is at the top level of your access
  • the account sits directly inside the account you're searching

For accounts nested further down, you'll see the path instead.

Go back to your main account

When you're working in a sub-account, 'Back to All accounts' appears in the switcher section. Select it to return to the account you signed in to. The switcher closes and your main account loads, the same way it does when you switch to any other account.

You won't see this option while you're already in your main account.


Find and copy your Client ID

Every account has a Client ID that identifies it. It's the same clientId you use in Azupay API requests. You might need it to check which account you're working in, or to give to Azupay support when you raise a request.

You can see the Client ID whether or not your business has sub-accounts.

  1. Select your initials in the top bar.
  2. Find the Client ID under your current account name.
  3. Select the copy icon next to it.

You'll see "Client ID copied." once the ID is on your clipboard. The full ID is always copied, even if it's shortened on screen.

Copying doesn't switch accounts, close the switcher or move you to another page.

The Client ID shown always belongs to the account you're working in. Browsing or searching doesn't change it. When you switch accounts, including with Back to main account, the account name and Client ID update together.

Client IDs aren't shown in the account list. To get a sub-account's Client ID, switch to that account first.

While accounts are loading

The list can take a moment to load when you open the switcher or move to another level. You can't select an account until it finishes, and your current account stays the same.

Search shows its progress in the same way. When it's done, the results match your latest search and scope.

Can't find an account?

The account switcher takes around 10 minutes to update after a client has been created or updated.

You only see accounts you're authorised to access. If one is missing, check with your Dashboard administrator or raise a request through the Service Desk.


Related pages



Did this page help you?