> 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/java/payout-service/create-recipient.md).

# Create Recipient

## Overview

The `createRecipient` method registers a new recipient entity (individual or business) with the payment processor. This is often required before funds can be transferred to them.

## Purpose

Use this operation to set up a vendor, contractor, or user in the processor's system.

| Scenario             | Developer Implementation                                       |
| -------------------- | -------------------------------------------------------------- |
| Onboard a new seller | Call `createRecipient` with their details and `recipientType`. |

## Request Fields

| Field              | Type                            | Required | Description                                                             |
| ------------------ | ------------------------------- | -------- | ----------------------------------------------------------------------- |
| `merchantPayoutId` | string                          | No       | Your internal identifier for the payout/recipient operation.            |
| `address`          | PayoutAddress                   | Yes      | Address information associated with the recipient.                      |
| `payoutMethodData` | PayoutMethod                    | No       | Specific details of the payout instrument for the recipient.            |
| `amount`           | Money                           | Yes      | The amount to be paid out (if creating recipient inline with a payout). |
| `recipientType`    | PayoutEnums.PayoutRecipientType | Yes      | Type of entity (e.g., INDIVIDUAL, COMPANY).                             |
| `customer`         | Customer                        | No       | Details about the customer/recipient.                                   |
| `accessToken`      | SecretString                    | No       | Access token for the connector, if required.                            |

## Response Fields

| Field               | Type                     | Required | Description                                                |
| ------------------- | ------------------------ | -------- | ---------------------------------------------------------- |
| `merchantPayoutId`  | string                   | No       | Your internal identifier passed to the payout processor.   |
| `payoutStatus`      | PayoutEnums.PayoutStatus | No       | The status of the recipient creation.                      |
| `connectorPayoutId` | string                   | No       | The unique identifier assigned to the recipient or payout. |
| `error`             | ErrorInfo                | No       | Details of any error that occurred.                        |
| `statusCode`        | uint32                   | Yes      | The HTTP status code returned from the connector.          |

## Example

### SDK Setup

```java
import com.hyperswitch.prism.PayoutClient;
import java.util.Map;
import java.util.HashMap;

PayoutClient payoutClient = PayoutClient.builder()
    .connector("stripe")
    .apiKey("YOUR_API_KEY")
    .environment("SANDBOX")
    .build();
```

### Request

```java
Map<String, Object> request = new HashMap<>();
request.put("recipientType", "INDIVIDUAL");
request.put("amount", Map.of("minorAmount", 0, "currency", "USD"));

Response response = payoutClient.createRecipient(request);
```

### Response

```java
{
    "payoutStatus": "SUCCESS",
    "connectorPayoutId": "acct_1Hh1XYZ2eZvKYlo2C",
    "statusCode": 200
}
```

## Next Steps

* [Transfer Payout](/integrations/prism/java/payout-service/transfer.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 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/prism/java/payout-service/create-recipient.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.