Skip to main content
The Hyperswitch Payments API enables businesses to accept, process, and manage payments seamlessly. It supports the entire payment lifecycle—from creation to capture, refunds, and disputes—allowing smooth integration of various payment methods into any application with minimal complexity.

​
How to try your first payment through hyperswitch?

You have two options to use the Payments API:
  1. Sandbox API Key (Dashboard) – Quick testing without setup.
  2. Self-Deploy – Create merchants and API keys through Rest API.
Each option has specific nuances, we have mentioned the differences in the below step by step guide
We recommend using our Dashboard to generate API Key and setting up Connectors (Step 4) for faster trial and simple setup.
1

Create a Merchant Account

This account is representative of you or your organization that would like to accept payments from different

Hyperswitch Dashboard flow

Access the and sign up -> Sign up here is equivalent to creating a Merchant Account

Self-Deploy flow

Use the admin api key and the Merchant Account - Create endpoint to create your Merchant Account
2

Create API Key

You can now generate an API key that will be the secret key used to authenticate your payment request

Hyperswitch Dashboard flow

In Dashboard go to Developer-> API Keys -> +Create New Api Key. This key can be used in your API requests for authentication.

Self-Deploy flow

Use the admin api key and the Merchant Account - Create endpoint to create your Merchant Account
3

Set up Connectors

Connect the payment connectors and payment methods that your organization will accept. Connectors could be a payment processor/facilitator/acquirer or a provider of specialized services like Fraud/Accounting

Hyperswitch Dashboard flow

In Dashboard go to Connectors -> . Choose the payments methods to enable and complete setup.

Self-Deploy flow

Use the admin api key and the Connector Account endpoints to set up a connector
4

Try your first payment

You are all set! Go ahead and try the Payments API, be sure to try the different use cases provided

We are here to help

Test the use cases you are interested in and in case of difficulty, feel free to contact us on our slack channel
⌘I