Adding Additional Users and Managing Permissions for a Submerchant
Adding Additional Users and Managing Permissions for a Submerchant
How users are added and managed for a submerchant depends on the type of cooperation with PAY. For Business Partner, ISO, and Connect partnerships, self-service by the submerchant is preferred when an authorized user already exists. In an Alliance setup, user management is handled by the alliance: new users can be added through the portal or the API, while permissions can only be modified afterward via the API.
First Determine Who Is Responsible for User Management
Business Partner, ISO and Connect
Is there already at least one user in the submerchant account with permission to manage users? If so, preferably refer the customer to that user so they can manage users themselves. Instructions can be found in User Management.
As a partner, you can also add a new user through the submerchant management section. However, permissions can only be configured during user creation. They cannot be modified later through this partner route in the portal.
This limitation applies only to the partner route. It is separate from the user management capabilities available to an authorized user within the merchant's own account.
Alliance
In an Alliance setup, user management is handled by the alliance. The alliance can add new users through submerchant management in the portal or via the API. When adding users through the portal, permissions must be configured immediately; they cannot be changed later through this portal route. For ongoing permission management, the alliance must use the API.
Within this type of cooperation, a submerchant does not necessarily have access to the PAY. portal. Therefore, refer the submerchant to the alliance for user management rather than to portal-based self-service.
Adding a User Through the PortalThis partner route can be used for Business Partner, ISO, Connect, and Alliance partnerships.
- Open Submerchant Management in the PAY. portal.
- Locate the submerchant for which you want to add an additional user.
- Verify that you have selected the correct merchant.
- Click the gear icon next to the submerchant.
- Select Add New User.
- Enter the user's details and immediately assign the required permissions.
- Review the user details and permissions before completing the process.
Important: Configure permissions during user creation. Through this route, permissions can only be assigned when the user is created. After the user has been added, permissions cannot be modified through this partner route in the portal. Therefore, determine in advance which level of access the user requires.
This process is performed directly through submerchant management. It is not necessary to impersonate the submerchant account first.
Managing Users and Permissions Through the API
For Business Partner, ISO, Connect, and Alliance partnerships, adding users through the API is an alternative to adding them through the portal. The API also allows permissions to be managed after a user has been created. In an Alliance setup, these actions are performed by the alliance.
Adding a User
Use the API documentation for adding a license as the technical starting point. Follow the current documentation for the required parameters and request structure for the relevant submerchant. Include the required permissions when configuring the user's access.
Managing Permissions After Creation
Unlike adding a user through the portal, the API also supports permission management after the user has been created.
Granting access and modifying permissions later are separate operations. For permission changes, consult the relevant management operation in the API documentation. The API endpoint used to create a user is not automatically the same endpoint used to modify permissions.
Only grant a user the permissions that are necessary for their activities within the relevant submerchant account.
Which Route Fits Your Situation?
| Situation | Route |
|---|---|
| Business Partner, ISO, or Connect: a user with user-management permissions already exists | Preferably have the customer manage users themselves according to the User Management article. |
| Business Partner, ISO, or Connect: the partner needs to add a user | Submerchant Management → Gear Icon → Add New User. Configure permissions during creation. |
| Business Partner, ISO, or Connect: permissions need to be changed afterward | Have an authorized submerchant user manage the permissions themselves, or use the API. Changes cannot be made through the partner route in submerchant management. |
| Alliance: add a user | The alliance can add the user through submerchant management in the portal or via the API. When using the portal, permissions must be configured during creation. |
| Alliance: modify permissions after creation | The alliance must use the API. Permission changes are not available through the partner route in the portal. |
Permissions Forgotten or Configured Incorrectly?
Always consider the type of cooperation. For Business Partner, ISO, and Connect partnerships, self-service by an existing authorized user is preferred. For Alliance partnerships, user management is handled by the alliance. Users can be added through the portal or the API, while permission changes after creation must be performed through the API.