> 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/prism/api-reference/payout-service/create.md).

# Create

## Overview

The `Create` RPC in the Payout Service is used to initiate a transfer of funds from your merchant account to a customer, vendor, or third-party entity. This is commonly used in marketplaces, gig-economy platforms, or any business model requiring external disbursements.

## Purpose

This operation is the first step in the payout lifecycle. Use this when you have sufficient funds and wish to send money to a registered payout method (like a bank account, card, or wallet).

| Scenario                                    | Developer Implementation                                                   |
| ------------------------------------------- | -------------------------------------------------------------------------- |
| Send funds to a vendor                      | Call `Create` with the vendor's bank account details and payout amount.    |
| Refund a customer via an alternative method | Provide the customer's wallet or card details in the `payout_method_data`. |

## Request Fields

| Field                        | Type                       | Required | Description                                                       |
| ---------------------------- | -------------------------- | -------- | ----------------------------------------------------------------- |
| `merchant_payout_id`         | string                     | No       | Your internal identifier passed to the payout processor.          |
| `address`                    | PayoutAddress              | Yes      | The shipping and billing address associated with the payout.      |
| `connector_feature_data`     | SecretString               | No       | Connector-specific metadata or feature configurations.            |
| `payout_method_data`         | PayoutMethod               | No       | Specific details of the payout instrument (e.g., Card, ACH, Pix). |
| `connector_quote_id`         | string                     | No       | Pre-negotiated quote ID if applicable.                            |
| `connector_payout_id`        | string                     | No       | An existing payout identifier from the connector, if any.         |
| `amount`                     | Money                      | Yes      | The amount to be paid out along with the source currency.         |
| `destination_currency`       | Currency                   | Yes      | The currency in which the recipient will receive the payout.      |
| `customer`                   | Customer                   | No       | Details about the customer receiving the payout.                  |
| `priority`                   | PayoutEnums.PayoutPriority | No       | Priority of the payout (e.g., INSTANT, WIRE).                     |
| `connector_payout_method_id` | string                     | No       | The connector's unique ID for a stored payout method.             |
| `webhook_url`                | string                     | No       | URL where payout status updates should be sent.                   |
| `browser_info`               | BrowserInformation         | No       | Information about the user's browser, used for fraud prevention.  |
| `access_token`               | SecretString               | No       | Access token for the connector, if required.                      |
| `source_bank_data`           | SourceBankData             | No       | Details of the bank account from which the payout is funded.      |

## Response Fields

| Field                 | Type                     | Required | Description                                                |
| --------------------- | ------------------------ | -------- | ---------------------------------------------------------- |
| `merchant_payout_id`  | string                   | No       | Your internal identifier passed to the payout processor.   |
| `payout_status`       | PayoutEnums.PayoutStatus | No       | The current status of the payout (e.g., PENDING, SUCCESS). |
| `connector_payout_id` | string                   | No       | The unique payout ID assigned by the connector.            |
| `error`               | ErrorInfo                | No       | Details of any error that occurred during creation.        |
| `status_code`         | uint32                   | Yes      | The HTTP status code returned from the connector.          |

## Example

```bash
grpcurl -H "x-connector: stripe" \
  -H "x-connector-config: {\"config\":{\"Stripe\":{\"api_key\":\"$STRIPE_API_KEY\"}}}" \
  -d '{
    "amount": {"minor_amount": 1000, "currency": "USD"},
    "destination_currency": "USD",
    "payout_method_data": {
      "card": {
        "card_number": "4242424242424242",
        "card_exp_month": "12",
        "card_exp_year": "2027"
      }
    }
  }' \
  localhost:8080 types.PayoutService/Create
```

```json
{
  "payout_status": "PENDING",
  "connector_payout_id": "po_1Hh1XYZ2eZvKYlo2C",
  "status_code": 200
}
```

## Next Steps

* [Get Payout Status](/integrations/prism/api-reference/payout-service/get.md)
* [Void Payout](/integrations/prism/api-reference/payout-service/void.md)


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.hyperswitch.io/integrations/prism/api-reference/payout-service/create.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.