> 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/node/payout-service/transfer.md).

# Transfer

## Overview

The `transfer` method in the Payout Service is used to execute the actual fund transfer for a previously initiated payout, or to perform a combined create and transfer operation depending on the processor's flow.

## Purpose

Use this operation to move funds to the destination payout method.

| Scenario                  | Developer Implementation                                     |
| ------------------------- | ------------------------------------------------------------ |
| Execute a payout transfer | Call `transfer` with the required payout details and amount. |

## Request Fields

| Field                             | Type                       | Required | Description                                                                                                    |
| --------------------------------- | -------------------------- | -------- | -------------------------------------------------------------------------------------------------------------- |
| `merchantPayoutId`                | string                     | No       | Your internal identifier passed to the payout processor.                                                       |
| `address`                         | PayoutAddress              | Yes      | Address information associated with the payout.                                                                |
| `payoutMethodData`                | PayoutMethod               | No       | Specific details of the payout instrument.                                                                     |
| `connectorQuoteId`                | string                     | No       | Pre-negotiated quote ID if applicable.                                                                         |
| `amount`                          | Money                      | Yes      | The amount to be transferred.                                                                                  |
| `connectorPayoutId`               | string                     | No       | An existing payout identifier from the connector.                                                              |
| `destinationCurrency`             | 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 transfer.                                                                               |
| `connectorPayoutMethodId`         | string                     | No       | The connector's unique ID for a stored payout method.                                                          |
| `webhookUrl`                      | string                     | No       | URL where payout status updates should be sent.                                                                |
| `browserInfo`                     | BrowserInformation         | No       | Information about the user's browser.                                                                          |
| `accessToken`                     | SecretString               | No       | Access token for the connector, if required.                                                                   |
| `sourceBankData`                  | SourceBankData             | No       | Details of the bank account from which the payout is funded.                                                   |
| `description`                     | string                     | No       | Description of the payout.                                                                                     |
| `connectorEligibilityReferenceId` | string                     | No       | Connector's reference for a prior eligibility check, when the processor requires it to authorise the transfer. |

## Response Fields

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

## Example

### SDK Setup

```javascript
const { PayoutClient } = require('hyperswitch-prism');

const payoutClient = new PayoutClient({
    connector: 'stripe',
    apiKey: '[REDACTED_ENV_SECRET]',
    environment: 'SANDBOX'
});
```

### Request

```javascript
const request = {
    amount: {
        minorAmount: 1000,
        currency: "USD"
    },
    destinationCurrency: "USD",
    payoutMethodData: {
        card: {
            cardNumber: "4242424242424242",
            cardExpMonth: "12",
            cardExpYear: "2027"
        }
    }
};

const response = await payoutClient.transfer(request);
```

### Response

```javascript
{
    payoutStatus: "SUCCESS",
    connectorPayoutId: "tr_1Hh1XYZ2eZvKYlo2C",
    statusCode: 200
}
```

## Next Steps

* [Get Payout Status](/integrations/prism/node/payout-service/get.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/node/payout-service/transfer.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.