> 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/eligibility.md).

# Check Eligibility

## Overview

The `eligibility` method in the Payout Service checks whether a payout can be made to a given payout method before funds are committed. It is used for pre-verification flows such as SEPA Verification of Payee (VoP) and other payee-verification checks.

## Purpose

Use this operation to validate a payee or payout method before initiating a transfer, reducing the risk of failed or misdirected payouts.

| Scenario                       | Developer Implementation                                                             |
| ------------------------------ | ------------------------------------------------------------------------------------ |
| Verify a payee before transfer | Call `eligibility` with the payout method and amount, then inspect `payoutEligible`. |
| Pre-check a bank account       | Call `eligibility` with the bank details to confirm the account can receive funds.   |

## Request Fields

| Field                  | Type           | Required | Description                                                  |
| ---------------------- | -------------- | -------- | ------------------------------------------------------------ |
| `merchantPayoutId`     | string         | No       | Your internal identifier for the eligibility check.          |
| `connectorFeatureData` | SecretString   | No       | Connector-specific metadata passed to the eligibility check. |
| `payoutMethodData`     | PayoutMethod   | No       | Specific details of the payout instrument being checked.     |
| `amount`               | Money          | Yes      | The amount to be paid out.                                   |
| `connectorPayoutId`    | string         | No       | An existing payout identifier from the connector.            |
| `destinationCurrency`  | Currency       | Yes      | The currency in which the recipient will receive the payout. |
| `accessToken`          | SecretString   | No       | Access token for the connector, if required.                 |
| `address`              | PayoutAddress  | No       | Address information associated with the payout.              |
| `customer`             | Customer       | No       | Details about the customer receiving the payout.             |
| `sourceBankData`       | SourceBankData | No       | Details of the bank account from which the payout is funded. |

## Response Fields

| Field                             | Type                     | Required | Description                                                                                                                      |
| --------------------------------- | ------------------------ | -------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `merchantPayoutId`                | string                   | No       | Your internal identifier for the eligibility check.                                                                              |
| `payoutStatus`                    | PayoutEnums.PayoutStatus | No       | The current status of the payout.                                                                                                |
| `connectorPayoutId`               | string                   | No       | The unique payout ID assigned by the connector (set only when the payee is eligible).                                            |
| `error`                           | ErrorInfo                | No       | Details of any error that occurred during the check.                                                                             |
| `statusCode`                      | uint32                   | Yes      | The HTTP status code returned from the connector.                                                                                |
| `payoutEligible`                  | bool                     | No       | Whether the payout is eligible.                                                                                                  |
| `connectorMetadata`               | SecretString             | No       | Connector-specific details as a JSON object, surfaced to the merchant.                                                           |
| `connectorEligibilityReferenceId` | string                   | No       | Connector's reference for the eligibility check itself. Set for every verdict so the check remains traceable for reconciliation. |

## Example

### SDK Setup

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

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

### Request

```javascript
const request = {
    amount: {
        minorAmount: 1000,
        currency: "USD"
    },
    destinationCurrency: "USD",
    payoutMethodData: {
        ach: {
            bankAccountNumber: "000123456789",
            bankRoutingNumber: "110000000"
        }
    }
};

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

### Response

```javascript
{
    payoutEligible: true,
    connectorEligibilityReferenceId: "elig_1Hh1XYZ2eZvKYlo2C",
    statusCode: 200
}
```

## Next Steps

* [Transfer Payout](/integrations/prism/node/payout-service/transfer.md)
* [Create Payout](/integrations/prism/node/payout-service/create.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/eligibility.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.