# Retrieve payout request batches

Retrieves a list of payout request batches.

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

## Query parameters:

  - `limit` (integer)
    Limits the number of collection items to be returned.

  - `offset` (integer)
    Specifies the starting point within the collection of items to be returned.

  - `filter` (string)
    Criteria for filtering collection items.
This field requires a special format.
Use , to specify multiple allowed values.
Use ; to specify multiple fields.

For more information, see Search filters.

  - `sort` (array)
    Sorts and orders the collection of items. To sort in descending
order, prefix with -. Multiple fields can be sorted by separating each with ,.

## Response 200 fields (application/json):

  - `id` (string)
    ID of the batch.
    Example: "preq_batch_0YVDMDE2BMC6KBB5MX76RF6T80"

  - `userId` (string)
    ID of the user who created the batch.
    Example: "usr_0YVCEENYJ3D7Q9EN6BN16HA0G4"

  - `status` (string)
    Status of the batch.
    Enum: "pending", "processing", "completed", "failed"

  - `totalCount` (integer)
    Total number of payout requests in the batch.
    Example: 10

  - `successCount` (integer)
    Number of payout requests successfully processed.
    Example: 8

  - `failureCount` (integer)
    Number of payout requests that failed to process.
    Example: 2

  - `customerCount` (integer)
    Number of unique customers in the batch.
    Example: 3

  - `totalAmountByCurrency` (array)
    Total payout amount grouped by currency in the batch.

  - `totalAmountByCurrency.currency` (string, required)
    Currency code in ISO 4217 format.

  - `totalAmountByCurrency.amount` (number, required)

  - `description` (string,null)
    Optional description of the batch.
    Example: "Batch processed on 2024-01-15"

  - `allocationOrder` (array,null)
    Order for auto-allocation of payout requests in this batch.
When set, this field overrides the organization-level allocation order during batch auto-allocation.
Must contain selected-payment-instrument exactly once.
Valid values: payment-card (payment cards), alternative-payment-methods (catch-all for alternative payment methods), selected-payment-instrument (customer-requested instrument), or any payment method API name (for example, paypal, Interac-eTransfer).
    Example: ["paypal","Interac-eTransfer","payment-card","alternative-payment-methods","selected-payment-instrument"]

  - `createdTime` (string)
    Date and time when the batch was created.

  - `updatedTime` (string)
    Date and time when the batch was last updated.

  - `_links` (array)
    Related links.

  - `_links.href` (string)
    Link URL.

  - `_links.rel` (string)
    Type of link.
    Enum: "self", "payoutRequests"

## 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 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.