The Payments Hub User Guide

Getting Started

Creating Your Password

Logging In

Forgotten Your Password

User Profile

Your Dashboard

User Management

Configuration

Use the Create Button

Log Out

Help and Support


Introduction to the allpay Payments Hub

The allpay Payments Hub provides a secure, central location for accessing and managing your allpay products and services.

Whether your organisation uses a single product or a range of allpay solutions, the Payments Hub makes it easy to access them all from one convenient portal. From here, you can manage your account, access your products and, where permitted, complete administrative tasks for your organisation.

Getting Started

To access the Payments Hub for the first time, you will need to accept an email invitation. This invitation may be sent directly by allpay (for your super administrator) or by an administrator within your organisation.

Select Create a Payments Hub Account within the invitation email and follow the on-screen instructions to:

  • Confirm your email address
  • Create and confirm a password
  • Enter your first and last name

Once these steps have been completed, your Payments Hub account will be ready to use.


Already have a Payments Hub account? If your email address is already linked to a Payments Hub account, Step 1 of the invitation will say 'Accept the invite in your Payments Hub Account'. See Organisation Invitations for more information.

Invitations remain valid for 30 days. If your invitation expires, you will need to ask an organisation administrator to send you a new one.

Creating a Password

When creating a password, it must meet the following requirements:

  • Be between 12 and 64 characters long
  • Include at least three of the following four requirements:
    • Uppercase letters
    • Lowercase letters
    • Numbers
    • Special characters
  • Be unique to your account

Passwords are case-sensitive.


For security reasons:

  • Do not share your password with anyone
  • Avoid using generic or shared passwords
  • Do not store passwords in unsecured locations

As an additional security measure, you may be required to update your password every 90 days.

Logging in

To sign in to the Payments Hub:

  1. Enter your email address as your username.
  2. Enter your password.
  3. Select Log In.

You will then be asked to complete multi-factor authentication before accessing your account.

For security purposes, your account will be temporarily locked after multiple unsuccessful login attempts within a short period. If this happens, please wait a few minutes before trying again.

If you continue to experience difficulties accessing your account, contact your Payments Hub administrator or the allpay Client Services team using the details provided at the end of this guide

Multi-factor Authentication

Multi-factor authentication adds an extra layer of protection to your Payments Hub account.

After entering your login details, you will be asked to enter a one-time passcode (OTP).

Receiving your passcode

If your account is registered with an email address only, your OTP will be sent automatically by email.

If you have added a mobile number to your profile, you can choose to receive your OTP by text message instead.


Entering your passcode

Your OTP:

  • Contains six digits
  • Is valid for 15 minutes
  • Can only be used once

Enter the code in the OTP field and select Verify OTP.


If your code expires before use, simply request a new one.


You will normally only be asked to complete multi-factor authentication the first time you log in each day. However, you may also be asked to verify your identity when signing in from a different device or after logging out and back in again.


Below is an example of the email you will receive containing your OTP code.

This is an example of the SMS you will receive containing your OTP code.

Forgotten Your Password?

If you cannot remember your password, select Forgotten your password? on the login page and follow the on-screen instructions to reset it.


You will be guided through the process step by step and will receive any necessary verification information by email.

User Profile

You can select the user icon in the top right at any point while using the Payments Hub to access your account information, your organisation information alongside Help and Support and Log out.

Use Manage Account for your user information such as your name, phone number and email address. If you have permission, you will also have the Manage Organisation button. Here you can check your business information, check your business contact information, and manage users in the Payments Hub.

For more information regarding managing users please refer to User Management. Help & Support is available to all users and acts as a quick link to the Payments Hub training library.

You can do this via the pull-down menu in the User Profile button.




Manage Account

Here is where to edit your own login details:


Personal Information

Use this link to update your personal details, such as your name, phone number, and email address.


Change Password

To change your password, in your user profile under Manage Account, select the Security option, and Password.

You are required to enter your current password and then enter a new password twice to confirm.

Add a mobile number

To add your mobile number to your user profile, click Manage Account, Personal Information, and select Phone.

To add your mobile number click Edit, add your mobile number, then click Save.


Organisation Invites

In certain circumstances it may be required for users to access data from multiple Payments Hub organisations, for example when two organisations merge.

At the top of the Organisation Invites page you will find any pending invitations outlined in a blue box. To accept an invitation, select Accept on the right of the corresponding row. Once a user is a member of another organisation they can switch to that organisation at any time as outlined in 4.3 Switch Organisation.

Also available on this page is a list of organisations which you currently have access to. On the right of each row, you can find a quick reference to the user roles which you hold within an organisation.

Invitations last for 30 days or until they are accepted. Once an invitation has expired you will no longer be able to join the organisation until a new invitation is sent.

Upon accepting an invitation to an organisation, the system will log you out.


Manage Organisation

If you have the appropriate permissions, Manage Organisation allows you to do a wide range of administrative tasks such as view Business Information, Manage Users and Client Code Groups.


Business Information: highlights the name, address and contacts of the business as shared during your onboarding with allpay.


Manage Users: Here you can invite, view and bulk upload users. For full details visit the User Management Section


Client Code Groups: Client Codes are used to separate revenue streams and support different technical solutions. All the allpay payments of products and services utilise client codes. 


From Client Code Groups you can view a list of all your current client codes alongside their current description. Select Edit and you can modify the client code description. When you have made the changes to the client code description select Save Changes. 

A client code description can only contain letters, numbers, spaces and limited special characters (.,'-!()?;:'"/,). There is a limit of 75 characters and client code description cannot be empty. 

You may notice a few additional buttons in your Manage Organisation menu. These areas are mainly used during the initial setup of your organisation by allpay’s technical and onboarding teams. A brief overview is provided below, but you will not need to use these sections as part of your day‑to‑day activity.

Integrations

The Integrations area links your organisation to external 3rd parties, i.e. housing management system. You can have multiple integrations within your organisation.


Client Codes

The Client Codes are payment-related codes used within allpays services. These will be managed by allpay for you.  No action is required in this section.


OAuth

The OAuth area is a secure method your system uses to access allpays API's.

-No passwords or manual logins needed.

-Access can be restricted per integration.

Switch Organisation:

If you are registered for multiple organisations, you will have a further option to Switch Organisation.

When selecting this option, you will be presented with a menu of all organisations you are currently a member of, click the one you would like to access, and the Payments Hub will reload your account for that organisation.

Please Note: Users will require separate permissions and client code access for every organisation that they are a member of.

Logout:

To log out of your account, click on the user icon and click Log Out.

Once you have logged in, to create a new client code group, follow the steps below:-


Dashboard

Once you are logged into the allpay Payments Hub, you will be taken to the Dashboard where you can access your payment products.

You will only be able to access products that your organisation has signed up for. If any are greyed out (as with the Direct Debit product below) your user does not have permission to access this product. To enable products greyed out in this way please refer to User Management

To navigate around the Payments Hub you have two options. The first option is to use the quick navigation side bar available most of the time that you are using the hub, all of your products and services are available quickly here and are organised into groups such as Data & Analytics and Payments. You can use the quick navigation side bar to get between different products quickly. You can also choose to hide the text on the quick navigation side bar using the hide icon near the bottom.

You can now use the PIN icon to the right of every product to PIN a product to your left side quick navigation.

The other way you can navigate around the Payments Hub is using the Dashboard, after you log-in or after you select Home on the quick navigation side bar you will be returned to the Dashboard. The dashboard displays all of your products and services in a collage of tiles in the centre of the screen. To access any product using the dashboard, simply click on the corresponding tile.

On the dashboard you will see each product and service that your account is enabled for, select to access the respective product or service.

YOUR PRODUCTS and SERVICES


All of the payment products available to your organisation are shown on the allpay Payments Hub dashboard. You can access a product by selecting its tile or by using the menu on the left-hand side. This menu may also be pinned for your convenience.


Some organisations may have only one product, while others may have several. Only products and services your organisation has signed up for will be active; any others will appear greyed out and cannot be used.

Payments Hub Dashboard

User Management

If you are an Organisation Administrator, you will be able to invite and manage users in the Payments Hub. This includes determining which users can access the following products and what permissions they have for these products. Please visit the product specific user guide for more information on how to apply permissions.


Callpay

Customer Account Manager

Direct Debit

File Manager

Gateway Plus

Messaging

Prepaid via the Payments Hub

Transaction Manager

Total Connect

Invite New User

To invite a new user on Payments Hub, please follow the steps below:

1. Log into Payments Hub and navigate to the user icon in the top right hand of the screen. Select Manage Organisation.

  1. Select the Manage users tab.

  1. Select Invite users tab.

  1. Enter the email address into the Email addresses box. To invite multiple users to the Payments Hub use the enter key after each new email address. All users invited in this batch will share the permissions that you select below.

  1. Select and customise permissions for the user(s) accordingly. Please note that if no permissions are enabled in the File Manager category, the product will appear greyed out and the user(s) will be unable to access it.

  1. Select Send Invite at the bottom of the page. The user will receive an invitation email as described in Getting Started in the Hub. If a user’s email address is already registered with the Payments Hub, they can alternatively join an organisation through Organisation Invites.

Users will only be able to download payment information files associated with client codes in client code groups that they are members of.

Manage Existing Users

  1. Log into the payments hub and select Manage Organisation.

  1. Select Manage Users tab.

  1. Select View Users tab.


  1. Your users will be listed in creation order. Find the user that you would like to modify and select Edit.

    If need to amend multiple users' permission, you can use the Bulk upload function

  1. Here you can change a user’s First Name, Last Name and Email Address. Additionally, you can adjust a user’s assigned Roles. It is important to note that disabling a user will temporarily suspend their ability to log in, while deleting a user will permanently revoke their access privileges.

6. Select Save to confirm any changes.


As with new Users, amended Users will only be able to download payment information files associated with client codes in client code groups that they are members of.

Update Users in Bulk

The Bulk Upload feature allows administrators to update multiple users at the same time.

This can be used to:

  • Add new users
  • Assign permissions
  • Remove permissions
  • Update roles

Download a Template

  1. Open Manage Users.
  2. Select Bulk Upload.
  3. Select either:
    • Sample Template
    • Template with Current Data
  4. If selecting Template with Current Data, review the Product permissions template and customise to reflect the products you wish to manage the permissions of.
  5. Once the products are selected, click Download template

As a default, all of your organisation's products are automatically ticked for you (as above).

Click  Clear Selection to refresh the choices.

Complete the Template

Add or remove an X in the relevant permission fields to update access.

Do not change any column headings, as this will prevent the file from being processed correctly.

To prevent any errors when uploading the file the header titles must remain untouched in order for the template to function properly.

Upload the Template

  1. Save the completed file.
  2. Select Upload File.
  3. Drag and drop the file, or browse for it.
  4. Select Submit Request.

If any errors are identified, the Payments Hub will highlight the affected fields so they can be corrected and resubmitted.

Configuration

The Configuration area provides information about how products and services have been set up for your organisation.

This information will vary depending on the products your organisation uses.

Product Configuration

Product Configuration displays the settings that apply to your organisation's products and services.

Depending on the product, this may include:

  • Transaction limits
  • Programme restrictions
  • Customer eligibility rules
  • Regional controls
  • Product-specific settings

This section can be useful when reviewing how a product has been configured during implementation.

Use of the Create Button

The green Create button provides quick access to commonly used actions.

The options available will depend on the products and services enabled for your organisation.

Examples may include:

Select Create and choose the action you would like to complete.

Log Out

When you have finished using the Payments Hub, we recommend logging out of your account.

To log out:

  1. Select the user icon.
  2. Select Log Out.

Logging out helps keep your account secure, particularly when using a shared or public device.

Help and Support

If you need assistance using the Payments Hub, visit the Help & Support area within the platform.

You can access product guides, training materials and support resources designed to help you get the most from your allpay services.

If you require further assistance, please contact the allpay Client Services team using the contact details provided by your organisation or on the allpay website.