Setup Instructions

The Hyperswitch Payments API enables businesses to accept, process, and manage payments. It supports the entire payment lifecycle—creation, capture, refunds, and disputes—allowing integration of various payment methods into your application.

How to try your first payment through Hyperswitch?

You have two options to use the Payments API:

• Sandbox API Key (Dashboard) — quick testing without setup.

• Self-Deploy — create merchants and API keys through REST API.

Each option has specific nuances. The recommended fast path is to use the Dashboard to generate an API Key and set up connectors.

1

Create a Merchant Account

This account represents you or your organization that will accept payments via Hyperswitch.

Hyperswitch Dashboard flow

• Access the Dashboard and sign up -> Sign up here is equivalent to creating a Merchant Account. Link: https://app.hyperswitch.io/dashboard/login

Self-Deploy flow

• Use the admin API key and the Merchant Account - Create endpoint to create your Merchant Account. Link: https://api-reference.hyperswitch.io/v1/payments/api-reference/merchant-account/merchant-account--create

2

Create API Key

Generate an API key that will be used to authenticate your payment requests.

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. Link: https://api-reference.hyperswitch.io/v1/payments/api-reference/merchant-account/merchant-account--create

3

Set up Connectors

Connectors are payment processors, facilitators, acquirers, or providers of specialized services (eg. fraud/accounting). Configure the connectors and payment methods your organization will accept.

Hyperswitch Dashboard flow

• In Dashboard go to Connectors -> +Connect a Dummy Processor. Choose the payment methods to enable and complete setup.

Self-Deploy flow

• Use the admin API and the Connector Account endpoints to set up a connector. Link: https://api-reference.hyperswitch.io/v1/payments/api-reference/merchant-connector-account/merchant-connector--create

4

Try your first payment

Once merchant, API key, and connectors are set up, call the Payments API to create a payment and test different use cases.

Payments API (create payment) endpoint: https://api-reference.hyperswitch.io/v1/payments/api-reference/payments/payments--create

We recommend using the Dashboard (https://app.hyperswitch.io/dashboard/login) to generate an API key and set up connectors for a faster trial and simpler setup.

Need help testing? Join the Hyperswitch Slack channel: https://join.slack.com/t/hyperswitch-io/shared_invite/zt-2jqxmpsbm-WXUENx022HjNEy~Ark7Orw

Further resources:

• Go-live Checklist: https://api-reference.hyperswitch.io/essentials/go-live

• Payment Flows: https://api-reference.hyperswitch.io/v1/payments/payment--flows