Managing Accounts and Profiles
Create multiple merchant accounts, profiles and users for seamless integration with your business.
Last updated
Create multiple merchant accounts, profiles and users for seamless integration with your business.
Last updated
Follow this guide to understand where your business use case fits with hyperswitch architecture.
If there are more than one business_profiles for a merchant account, then passing profile_id when creating a payment is mandatory.
Hyperswitch Architecture supports
Creating multiple merchant accounts under an organization.
Creating multiple business profiles under each merchant account.
Create multiple instances of a processor ( Stripe, Adyen etc ) under a business profile.
Here's how the architecture would look like.
Organization refers to the main business. When a new user registers, an organization is created and the user assumes the role of organization admin.
A merchant account is associated with an api_key and publishable_key which is used for authentication. There can be many merchant accounts that can be created under an organization by an organization admin.
Every merchant account has at least one profile. For easier integration,profile_id is not mandatory if there is only one business profile.
A profile can also be considered to be a business profile for practical purposes, it serves as a logical separation of businesses for seamless integration and onboarding. Every business profile is uniquely identified by a profile_id. All the payment settings can be configured at the profile level and will apply to all the payments make via the business profile. If there is more then one business profile, then profile_id has to be passed when creating the payments. Business profile allows to configure
Roles and permissions for users can be assigned at the organization level, and merchant level.
Routing Algorithm.
Only gateways that are available under the business profile can be used to configure the routing algorithm.
If a routing algorithm is not available, a default fallback, which consists of all the processors configured under the business profile based on priority order would be used. The priority of processors in the default fallback can be configured
Webhook url and Return url for payments.
There can be multiple processors configured under a business profile. Each processor is associated with a globally unique identifier merchant_connector_id and unique identifier under a business profile called label
A processor created under one business profile cannot be used in another business profile to route payments.
Consider a merchant A who has three different businesses - A_Shoes, A_Clothing, A_Bags. They can create three merchant accounts (Shoes, Clothing, Bags) on Hyperswitch and get separate set of API keys for each of them.
In case of Marketplace merchants with multiple sub-merchants, the parent merchant can create one Hyperswitch merchant account (with an API key) for themself and as many separate merchant accounts as they need for the sub-merchants under them with separate API keys for each of them
Multiple business Profiles - For merchants who want to manage all businesses with one API key
For a merchant A with three different businesses (A_Clothing, A_Shoes, A_Bags) they can create just one merchant account on Hyperswitch with three business profiles (Clothing, Shoes, Bags) under it. This way, the merchant can use only one Hyperswitch API key to manage transactions for all three businesses.
For Marketplace merchants with multiple sub-merchants, the parent merchant can create one Hyperswitch merchant account with an API key access and multiple business profiles under it to represent the different sub-merchants. This way the parent merchant will be able to manage their multiple sub-merchants tightly under one Hyperswitch merchant account and API key.
When you sign up on Hyperswitch, a merchant account and a profile is created under your organisation account by default.
To create more merchant accounts, click the merchant account dropdown from the left top corner in your Hyperswitch dashboard, and click on the create new merchant option.
To create more profiles, click the profile dropdown from the right top corner in your Hyperswitch dashboard, and click on the create new profile option. Here you will also see a list of already configured business profiles for your merchant account.
As mentioned already, a ‘default’ profile is already created during your merchant account creation. 'profile_id’ of various business profiles can be found under Settings → Business Profiles.
Enter a name for your profile in the next pop-up screen and click ‘Add’ again. A new profile with the given ‘profile_name’ and an automatically generated ‘profile_id’ is created.
How to route a payment to a particular merchant account and a particular profile?
In order to route a payment to a specific merchant account, the payment create API call has to be made from the merchant server using the correct API key attached to the required merchant account. To route the payment to a particular profile, the profile_id parameter of the required profile is to be passed.
When a payment is created under a business profile, it would use the routing algorithm ( if available) that is configured for that business profile, to choose an appropriate gateway. All the Refunds, Mandates that are created for a payment will be under the same business profile as the payment.
