Manage Your Team

Assign roles and permission to users

Follow this guide to understand how to set up your team in Hyperswitch and to manage access through roles and permissions

You can manage your team - invite / add new users, assign roles and update roles (upcoming) - through the Hyperswitch control center. Currently, Hyperswitch provides 7 default roles for you to configure.

Default Roles

Our system currently offers a set of default roles, each with predefined permissions:

1. Organization Admin

  • Full access to the platform, including user management, transaction oversight, system configuration, and reconciliation.

  • Can create new merchants from the dashboard.


2. Merchant Admin

  • Full access to merchant-related information, including user management, transaction oversight, and system configuration.

  • Cannot create new merchants but can manage all other merchant operations.


3. Profile Admin

  • Full control over profile-level operations, connectors, workflows, analytics, users, and merchant details.

  • Can manage and configure all aspects of the profile.


4. Merchant Developer

  • Can create and manage API keys.

  • Has view access to operations, connectors, analytics, users, and merchant details, with the ability to manage merchant details.


5. Profile Developer

  • Can create and manage API keys for the profile.

  • Has view and manage access to operations, connectors, analytics, users, and merchant details.


6. Merchant Operator

  • Can view and manage payment-related information, including refunds, mandates, and disputes.

  • Has view-only access to workflows, connectors, analytics, users, and merchant details.


7. Profile Operator

  • Can manage payment-related operations for the profile.

  • Has view access to connectors, workflows, analytics, users, and merchant details.


8. Merchant IAM

  • Can invite or add users to the merchant account.

  • Has restricted access to other modules, including operations, analytics, and merchant details.


9. Profile IAM

  • Can invite or manage users within the profile.

  • Has restricted access to operations, analytics, and merchant details.


10. Profile View Only

  • View-only access to all modules, including operations, connectors, workflows, analytics, users, and merchant details.


11. Merchant View Only

  • View-only access to all modules within the merchant, including operations, connectors, workflows, analytics, users, and merchant details.


12. Profile Customer Support

  • Can view transaction details and customer information necessary for handling queries and support issues.

  • View access to operations, analytics, users, and merchant details.


13. Customer Support

  • Can access transaction details and customer information needed for handling support queries.

  • View access to merchant operations, analytics, users, and merchant details.

These roles are designed to cater to the common operational hierarchies in most organizations.

Custom Roles:

This feature allows organisations to create roles with specific permissions that perfectly align with their unique operational structures and requirements. Custom roles can only be created at merchant roles.

Steps to create a custom role -

  • Go to Settings -> Users in the Hyperswitch Dashboard.

  • Switch to the Roles tab, and click on Create Custom Roles.

  • Define scope, and set permissions for the custom role you want to create.

Assigning Roles and Permissions: A Walkthrough

The process of assigning roles and permissions is straightforward:

  1. Accessing User Management: Administrators can access the User Management section from the dashboard. Under Settings -> Team

  2. Creating / Inviting New Users: Add new team members by entering their details and assigning them a role corresponding to their position in the organization. In case an email service is enabled, then an email is triggered to the invited users from where it can be accepted. If there is no email service, then the user is created for that merchant_id with a random password that can be shared.

  1. Modifying Roles: Existing users’ roles can be adjusted as needed, accommodating changes in responsibilities or positions. This is an upcoming feature.

Last updated