PaySwitch API Reference

PaySwitch REST APIs for payments, refunds, customers, and webhooks. JSON request/response bodies; standard HTTP status codes.

Environment

Environment	Router (API)	Dashboard
Dev (example)	http://95.217.96.123:8080	http://95.217.96.123:9000
Production	Your production router URL	Your production dashboard URL

Authentication

Send the secret API key in the api-key header for server-to-server calls. Use the publishable key only in client-side SDK initialization. Create keys in Dashboard → Developers → API Keys.

Never expose secret API keys in frontend code or public repositories.

Tags

Payments

Create and manage one-time payments, recurring payments and mandates

Refunds

Create and manage refunds for successful payments

Mandates

Manage mandates

Customers

Create and manage customers

Payment Methods

Create and manage payment methods of customers

Disputes

Manage disputes

Payouts

Create and manage payouts

Event

Manage events

Poll

Security Schemes

admin_api_key

Admin API keys allow you to perform some privileged actions such as creating a merchant account and Merchant Connector account.

apiKey

api_key

Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

apiKey

ephemeral_key

Ephemeral keys provide temporary access to singular data, such as access to a single customer object for a short period of time.

apiKey

jwt_key

Bearer token (JWT)

http

publishable_key

Publishable keys are a type of keys that can be public and have limited scope of usage.

apiKey