Please refer to the email from Access PaySuite containing your API and SUN details. If you cannot find this email or are unsure what information to enter on these screens, please contact our Access Digital Assistant and request to speak with a member of our support team.
📌Note: You will need your Client Code, API Secret, and Service User Number (SUN), which are provided in the setup email from Access PaySuite. These may also be referred to as an API key and API secret. In our system, your Client Code acts as the API key.
Sign in to the Middleware
Go to the Middleware login page.
Click Sign in with Xero.
Enter your Xero credentials.
Click Allow Access.
📌Note: If you have multiple organisations, click the Select another organisation drop-down, choose the required organisation, then click Continue (or Continue with multiple organisations if prompted). Each organisation requires its own Access PaySuite DDCMS account with separate API details. Please contact our Sales team to discuss account options and pricing before adding or authorising additional organisations.
Once connected, you can switch between organisations using the drop-down in the top-right MY ACCOUNT tab. If you have multiple organisations, you must complete the setup separately for each one.
You can disconnect an organisation at any time by going to Connected Apps in your Xero organisation settings.
Configure the Account
Go to the Configure Eazy Collect page.
On the API tab, enter your Client Code and API Secret.
Check that there are no leading or trailing spaces and click Save.
On the Schedule tab, select your Ad hoc Schedule.
📌Note: Choosing a schedule not configured for the Middleware will prevent payment collection.
Click Save.
On the Direct Debit Information tab, enter your SUN and company details.
Click Save.
If successful, you will be redirected to the Manage Contracts tab and see a confirmation message confirming your Direct Debit information has been saved.
Frequently Asked Questions
Where do I find my Client Code and API Secret?
These are in the setup email sent to you by Access PaySuite. If you do not have this email, please contact the Access Digital Assistant and request to speak with a support agent.
What is the difference between Client Code and API key?
They refer to the same credential. Client Code is the term used by Access PaySuite for a credential that other systems may refer to as an API key. During Xero integration setup, use your Client Code wherever an API key is requested.
Each organisation has its own unique Client Code and API Secret. These credentials are organisation-specific and cannot be shared or reused across multiple organisations.
What happens if I select the wrong schedule?
Payments will not be collected. Always select the Ad hoc Schedule unless Access PaySuite support has advised otherwise.
What should I check if configuration fails?
No leading or trailing spaces in the Client Code or API Secret
The Ad hoc Schedule is selected on the Schedule tab
The SUN entered matches exactly what was provided in the setup email
Your Xero connection is still active under Connected Apps (you can confirm this in your Xero organisation settings; if it has been disconnected, you will need to reconnect it by signing back into the Middleware)
If you require any assistance, please contact us via the Access Digital Assistant and request to speak with a member of the support team.