Getting Started with Payouts

To begin processing payouts with Hyperswitch, you must first establish accounts with your supported payout processors.

Overview

The following diagram illustrates the interaction between your application, the Hyperswitch orchestration layer, and the underlying payout processors.

Configuration Resources

Implementation requires the Hyperswitch Dashboard for configuration and the API for transaction processing.

• API Endpoint (Sandbox): https://sandbox.hyperswitch.io

• Hyperswitch Dashboard: app.hyperswitch.io

• Technical Reference: Payouts API Reference

Prerequisites

Before configuring your first payout, ensure you have the following credentials from your Dashboard:

1. A Hyperswitch account.

2. An API Key (located in the Developers section).

3. Your Merchant ID (available on the Home page).

Configuring Payout Processors

Log in to the Hyperswitch Dashboard and follow these steps to connect your processors.

Navigate to Payout Processors: Select the Payout Processors tab from the sidebar and Select Processor: Choose a processor from the supported list to open the configuration modal.

Payout Processors list

Provide Credentials: Enter the authentication keys required by the specific processor to enable communication.

Configuring auth keys for communicating with the processor

Enable Payment Methods: Select the specific payout methods (e.g., Bank Transfer, Cards) you intend to use for this processor.

Keep preferred payment methods enabled

Confirm Configuration: Once saved, the processor will appear as "Active" in your list.

Successfully configured!

Processing Payouts via API

For testing and initial integration, you can use the Hyperswitch Postman Collection.

Import Collection: Download and import the collection into your Postman workspace.

Import postman collection

Configure Environment Variables: In the Variables tab, set the following parameters:

• baseUrl: https://sandbox.hyperswitch.io

• merchant_id: Your unique merchant identifier.

• api_key: Your Hyperswitch API secret key.

Updating env variables in postman collection

Execute Payout: Navigate to the Process Payouts section of the collection to send a POST request to the /payouts/create endpoint.

Payouts with Saved Payment Methods