> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ach.netevia.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get All Batch Payouts

> An API endpoint for retrieving all batch payouts

This API retrieves a list of all batch payouts. The response provides details for each payout, including the total amount and relevant timestamps. Pagination options are available to efficiently manage large datasets.

<Info>
  This route is secured with **processor** token authentication.
</Info>

### Endpoint

GET **/3p/api/v2/batch-payouts**

### Query Parameter

| Fields          | Type    | Is Required | Description                                                                                                      |
| --------------- | ------- | ----------- | ---------------------------------------------------------------------------------------------------------------- |
| **per\_page**   | integer | No          | By default: 10 Min: 1 Max: 100                                                                                   |
| **start\_date** | string  | No          | This parameter will filter the user's records based on the creation date of the batch payout. Date format: Y-m-d |
| **end\_date**   | string  | No          | This parameter will filter the user's records based on the creation date of the batch payout. Date format: Y-m-d |
| **sort\_order** | string  | No          | By default: newest *Possible Value: newest oldest*                                                               |
| **page**        | integer | No          | By default: 1 Min: 1                                                                                             |

### Response

<CodeGroup>
  ```json Success (200) theme={"system"}
  {
      "status": true,
      "message": "",
      "data": {
          "batch_payouts": [
              {
                  "batch_payout_uuid": "9bd53fe1-ac74-4e81-b6f2-be88b7c86a68",
                  "amount": 10000,
            	    "date": "2024-04-18 01:00:20"
              },
              {
                  "batch_payout_uuid": "9bd945fb-c942-402b-8420-bbcf5094fd9b",
                  "amount": 12000,
            	    "date": "2024-04-19 01:00:20"
              }
          ],
          "pagination": {
              "current_page": 1,
              "total_pages": 3,
              "total_items": 30,
              "per_page": 10
          }
      },
      "errors": null,
      "error_code": null
  }
  ```
</CodeGroup>