## Find a payout

Retrieves a specific payout by its unique identifier or external ID.

## Endpoint signature

```http
POST https://api.reservepay.com/merchants/find-payout HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <token>

{
  payout_id: string,
}
```

Returns: object

## Request arguments

### `payout_id` (string)

**Required**. The unique identifier of the payout to retrieve. Can be either the payout UID
or the external ID.

## Response attributes

### `payout_id` (string)

**Always present**. The ID of the payout.

### `external_id` (string)

_Nullable_. The external ID of the payout.

### `status` (string)

**Always present**. The current status of the payout.

Possible values:

- `SUCCESSFUL`
- `SENT`
- `PENDING`
- `FAILED`
- `CANCELLED`

### `amount` (number)

**Always present**. The payout amount in subunits.

### `currency` (string)

**Always present**. The currency code of the payout.

### `created_at` (number)

**Always present**. The timestamp when the payout was created.

### `paid_at` (number)

_Nullable_. The timestamp when the payout was settled/paid.

### `sent_at` (number)

_Nullable_. The timestamp when the payout was sent.

### `bank_account_id` (string)

_Nullable_. The ID of the bank account for the payout.

### `bank_code` (string)

_Nullable_. The bank code identifying the financial institution.

### `bank_account_number` (string)

_Nullable_. The bank account number.

### `bank_account_name` (string)

_Nullable_. The name of the account holder.

### `bank_country_code` (string)

_Nullable_. The ISO country code where the bank account is located.

### `payout_method` (string)

_Nullable_. The payout method name.

### `mobile_number` (string)

_Nullable_. The mobile number for PromptPay payouts (when payout_method is mobile_number).

### `national_id` (string)

_Nullable_. The national ID for PromptPay payouts (when payout_method is national_id).

### `fees` (array)

**Always present**. The fees associated with the payout.

### `ref1` (string)

_Nullable_. The first custom reference (e.g., internal payout ID).

## Errors specific to this endpoint

### `NOT_FOUND`

This error occurs when no payout with the provided ID exists in your
merchant account. Double check that you're using the correct payout ID.

## Errors common to all endpoints

### `UNHANDLED_ERROR`

This error occurs when the server encounters an unexpected internal error that
it cannot handle gracefully. This typically happens due to bugs, infrastructure
issues, or edge cases that weren't anticipated during development.

### `INVALID_ARGUMENTS`

This error occurs when the request contains invalid or missing parameters.
Common cases include missing required fields, or values that don't match the
expected format or type.

### `BAD_VERSION`

This error occurs when making requests to an API version that does not exist.
This commonly happens when using an outdated SDK or when the API version
specified in the request URL is incorrect.