# Preview payout request batch results

Retrieves the total number of payout requests that match a specified filter or are associated with an existing batch.

Use this operation to preview the number of payout requests that would be included in a batch before creating it,
or to view aggregate information for an existing batch.

Provide either a filter or batchId query parameter, but not both.

Endpoint: GET /payout-request-batches/preview
Version: latest
Security: SecretApiKey, JWT

## Query parameters:

  - `filter` (string)
    Filter string that is used to select payout requests.
This field uses the same format as collection filter parameters.

Use semicolons to separate multiple filter conditions.
Available filter fields: id, status, websiteId, customerId, currency, amount, createdTime, updatedTime.

The batchId filter is not supported.
This prevents the addition of payout requests that are already included in a batch.
    Example: "status:pending;websiteId:ws_0YVDMDE2BMC6KBB5MX76RF6T80"

## Response 200 fields (application/json):

  - `filter` (string)
    Filter string that adds payout requests to preview.
    Example: "status:pending;websiteId:ws_0YVDMDE2BMC6KBB5MX76RF6T80"

  - `matchingCount` (integer)
    Number of matching payout requests.
    Example: 42

## Response 400 fields (application/json):

  - `type` (string)
    URI reference [[RFC3986](https://tools.ietf.org/html/rfc3986)] that identifies the problem type.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".
    Example: "https://www.rebilly.com/docs/"

  - `status` (integer)
    HTTP status code.

  - `title` (string)
    Short, human-readable summary of the problem type.
It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

  - `detail` (string)
    Human-readable explanation specific to this occurrence of the problem.

## Response 401 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 403 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 404 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 429 fields (application/json):

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".
    Example: "about:blank"

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.
    Example: "Rate Limit Exceeded"

  - `status` (integer)
    HTTP status code.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.
    Example: "A request cannot be executed because the user has sent too many requests within a certain period of time"

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.