Merchant Service Accounts

Create a Merchant Service Account, reveal its API key, and manage its enabled state in the Merchant Portal.

A Merchant Service Account is for a machine connecting to the system, not an individual user. The Portal generates an API key for the account instead of asking you to set a password. Its permissions are limited to the following:

View:

• Merchant Hierarchy
• Reports

Read/write access:

• Create Orders
• Authorisation
• Authorisation Reversal
• Capture (including partial capture)
• Void and Refunds (including partial refunds)
• Outlet Reports and Transaction Data

Open Merchant Service Accounts

1. Select the Settings option from the left menu bar.
2. Click on the Integrations panel. The Integration settings screen displays.
3. Click on the Merchant Service Accounts link. The Merchant Service Accounts page displays.

Create a Merchant Service Account

1. On the Merchant Service Accounts page, click New to open Add service account.
2. Enter a name and description for the account. Check both before saving: you cannot edit or delete Merchant Service Accounts after creation.
3. Click Add. The slide-out closes and the new account appears in the list. The Portal generates a unique API key for it.

Reveal an API key

1. Open Merchant Service Accounts and find the account in the list.
2. Click the hidden key in that row’s API key column to reveal it.

Enable or disable an account

1. Open Merchant Service Accounts and find the account in the list.
2. Use the account’s enable/disable toggle to select the state you want.