> For the complete documentation index, see [llms.txt](https://docs.hyperswitch.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hyperswitch.io/integrations/connectors-integrations/payouts/get-started-with-payouts.md).

# Payout features

Learn how to configure payout processors and process payouts via the Hyperswitch Dashboard and API.

To begin processing payouts with Juspay Hyperswitch, you must first establish accounts with your [supported payout processors](https://juspay.io/integrations).

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

<figure><img src="https://2522436862-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F47COcdNQRd7FH3TBRipx%2Fuploads%2Fgit-blob-a1b949632e0d1ba58fb7f77c77630ab4ab87d156%2Fimage%20(36).png?alt=media" alt=""><figcaption></figcaption></figure>

### 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](https://app.hyperswitch.io)
* Technical Reference: [Payouts API Reference](https://api-reference.hyperswitch.io/v1/payouts/payouts--create)

### Prerequisites

Complete these checks before following the walkthrough:

1. Confirm payouts are enabled for your account. If the **Payout Processors** tab is not visible, contact support before continuing.
2. Create or sign in to the payout processor accounts you plan to use.
3. Create an API key in the Dashboard **Developers** section.
4. Copy your Merchant ID from the Dashboard home page.
5. Configure at least one payout processor and enable the payout methods you intend to use.

### Request field guide

The create request uses `payout_type` for the method family and `payout_method_data` for the details:

* `payout_type`: `card`, `bank`, `wallet`, or `bank_redirect`, serialized in `snake_case` by [`PayoutType`](https://github.com/juspay/hyperswitch/blob/6fd72e5e6653326acaaf19b5f6aa76a524ff202e/crates/common_enums/src/enums.rs#L9081-L9090).
* `payout_method_data`: `card`, `bank`, `wallet`, `bank_redirect`, `passthrough`, or `bank_transfer`, serialized in `snake_case` by [`PayoutMethodData`](https://github.com/juspay/hyperswitch/blob/6fd72e5e6653326acaaf19b5f6aa76a524ff202e/crates/api_models/src/payouts.rs#L252-L261). The source marks `bank` deprecated and points new integrations at `bank_transfer`.
* With `bank_transfer`, `payout_method_type` is `ach`, `bacs`, `sepa`, `pix`, `pix_key`, `pix_emv`, `trustly`, `open_banking`, `payshap`, or `payshap_proxy`. These are the tagged wire values on [`BankTransfer`](https://github.com/juspay/hyperswitch/blob/6fd72e5e6653326acaaf19b5f6aa76a524ff202e/crates/api_models/src/payouts.rs#L421-L434).

```json
"payout_type": "bank",
"payout_method_data": {
  "bank_transfer": {
    "payout_method_type": "ach",
    "bank_account_number": "<account number>",
    "bank_routing_number": "<routing number>"
  }
}
```

`payout_type` is a plain string. `payout_method_data` is not: it is an object keyed by the method name, because [`PayoutMethodData`](https://github.com/juspay/hyperswitch/blob/6fd72e5e6653326acaaf19b5f6aa76a524ff202e/crates/api_models/src/payouts.rs#L252-L261) carries the method's details and is externally tagged. Sending `"payout_method_data": "bank_transfer"` is not a valid request. Inside `bank_transfer`, the method type is a field rather than another level of nesting, because [`BankTransfer`](https://github.com/juspay/hyperswitch/blob/6fd72e5e6653326acaaf19b5f6aa76a524ff202e/crates/api_models/src/payouts.rs#L421-L434) is tagged on `payout_method_type`.

Crypto assets, including USDT, are not payout method values in these enums.

#### Configuring Payout Processors

Log in to the [Hyperswitch Dashboard](https://app.hyperswitch.io) and follow these steps to connect your processors.

1. **Navigate to Payout Processors:** Select the **Payout Processors** tab from the sidebar, then choose a processor from the supported list to open the configuration modal.

   <figure><img src="https://2522436862-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F47COcdNQRd7FH3TBRipx%2Fuploads%2Fgit-blob-1a8581fa23863a597d4b190281234ae7f499a682%2Fimage%20(37).png?alt=media" alt=""><figcaption><p>Payout Processors list</p></figcaption></figure>
2. **Provide Credentials:** Enter the authentication keys required by the specific processor to enable communication.

   <figure><img src="https://2522436862-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F47COcdNQRd7FH3TBRipx%2Fuploads%2Fgit-blob-2e3c134d7d30a9e1f4e3a52cfe1315c99a131f61%2Fimage%20(43).png?alt=media" alt=""><figcaption><p>Configuring auth keys for communicating with the processor</p></figcaption></figure>
3. **Enable Payment Methods:** Select the specific payout methods (e.g., Bank Transfer, Cards) you intend to use for this processor.

   <figure><img src="https://2522436862-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F47COcdNQRd7FH3TBRipx%2Fuploads%2Fgit-blob-995dd4e8b9fe060104ae8c1ba89fc14666338a26%2Fimage%20(44).png?alt=media" alt=""><figcaption><p>Keep preferred payment methods enabled</p></figcaption></figure>
4. **Confirm Configuration:** Once saved, the processor will appear as "Active" in your list.

   <figure><img src="https://2522436862-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F47COcdNQRd7FH3TBRipx%2Fuploads%2Fgit-blob-3413aa4b92f3d171c0a8eb316a999bd075cb250a%2Fimage%20(66).png?alt=media" alt=""><figcaption><p>Successfully configured!</p></figcaption></figure>

#### Processing Payouts via API

For testing and initial integration, you can use the [Hyperswitch Postman Collection](https://www.postman.com/hs-payouts/hyperswitch/collection/u6uep7u/payouts-w-hyperswitch).

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

   <figure><img src="https://2522436862-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F47COcdNQRd7FH3TBRipx%2Fuploads%2Fgit-blob-8c6d8e906e48470f902a04d5d4c8d99b586a2ba4%2Fimage%20(8)%20(1).png?alt=media" alt=""><figcaption><p>Import postman collection</p></figcaption></figure>
2. **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.

   <figure><img src="https://2522436862-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F47COcdNQRd7FH3TBRipx%2Fuploads%2Fgit-blob-18550d39adaf0583772b06989253fd6877b632f0%2Fimage%20(67).png?alt=media" alt=""><figcaption><p>Updating env variables in postman collection</p></figcaption></figure>
3. **Execute Payout:** Navigate to the **Process Payouts** section of the collection to send a `POST` request to the `/payouts/create` endpoint.

{% content-ref url="/pages/BhrISH3IP4euAGa8kpEO" %}
[Payouts with Saved Payment Methods](/integrations/connectors-integrations/payouts/get-started-with-payouts/process-payouts-using-saved-payment-methods.md)
{% endcontent-ref %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.hyperswitch.io/integrations/connectors-integrations/payouts/get-started-with-payouts.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.