> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://en.docs.api.corpx.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://en.docs.api.corpx.com/_mcp/server.

# List PIX batches

GET https://tenant.api.corpx.com/v1/accounts/{accountId}/pix/batches

Lists this account's batches, newest first. `status` filters by batch
lifecycle state (lowercase or uppercase).


Reference: https://en.docs.api.corpx.com/baas/referencia/pix/list-pix-batches

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `accountId` (string, required) — Account identifier.

### Query parameters

- `status` (string, optional) — Filter by batch status (`draft`, `reviewing`, `reviewed`, `queued`, `processing`, `completed`, `partial_failed`, `failed`).
- `page` (integer, optional, default: 1) — Page number, starting at 1.
- `pageSize` (integer, optional, default: 50) — Number of batches per page.

### Headers

- `X-Tenant-Id` (string, required) — Tenant context used for authorization and routing.

## Response

### 200

Page of batch summaries

- `items` (list of PixBatch, required) — Batches in this page.
- `page` (integer, required) — Current page.
- `pageSize` (integer, required) — Requested page size.
- `totalItems` (integer, required) — Total matching batches.
- `totalPages` (integer, required) — Number of pages.
- `hasNext` (boolean, required) — Whether another page exists.

## Errors

### 403 Forbidden Error

`feature_disabled` or `pix_batch_account_disabled`.

- `errorCode` (string, required) — Stable machine-readable code. See `ErrorCode` for the known values.
- `message` (string, required) — Human-readable explanation (pt-BR). Presentation only; may change.
- `docs` (string, optional) — Link to this code in the public error catalogue.
- `requestId` (string, optional) — Gateway request id. Quote it when contacting support.
- `partner` (ErrorResponsePartner, optional) — Raw error from the settlement bank, when the failure came from it. Diagnostic only.

## Types

### PixBatch

PIX batch summary.

- `batchId` (string, required) — Batch identifier (`pxb_…`).
- `name` (string, required) — Optional operator-facing name; empty when omitted.
- `status` (enum, required) — Batch lifecycle. `DRAFT` and `REVIEWED` are editable (editing a `REVIEWED` batch returns it to `DRAFT`). `REVIEWING` is the asynchronous pre-flight. Dispatch requires `REVIEWED`. `COMPLETED`, `PARTIAL_FAILED` and `FAILED` are terminal and the only states with receipts.
  - Allowed values: `DRAFT`, `REVIEWING`, `REVIEWED`, `QUEUED`, `PROCESSING`, `COMPLETED`, `PARTIAL_FAILED`, `FAILED`
- `totalItems` (integer, required) — Number of staged items.
- `totalAmount` (string, required) — Amount in BRL as a decimal string with two places (`1234.56`).
- `completedItems` (integer, required) — Items settled so far.
- `failedItems` (integer, required) — Items failed so far.
- `limits` (PixBatchLimits, required) — Effective item limit for this account and where it comes from.
- `createdAt` (datetime, required) — Draft creation instant, in UTC.
- `updatedAt` (datetime, required) — Last persisted update, in UTC.
- `review` (PixBatchReview, optional) — Summary written when the review finishes (or aborts).
- `reviewedAt` (datetime, optional) — Instant the last review finished.
- `acknowledgedAt` (datetime, optional) — Instant the caller acknowledged the review at dispatch.
- `dispatchedAt` (datetime, optional) — Instant the batch was queued.
- `completedAt` (datetime, optional) — Instant every item reached an outcome.

### ErrorResponsePartner

Raw error from the settlement bank, when the failure came from it. Diagnostic only.

- `code` (string, optional)
- `message` (string, optional)
- `field` (string, optional) — Field the partner pointed at, when any.

### PixBatchLimits

Effective item limit for this account and where it comes from.

- `maxItems` (integer, required) — Maximum number of items per batch (`pixBatch.maxItems`; default 50).
- `source` (string, required) — Policy level that set the limit (`default`, `tenant` or `account`).

### PixBatchReview

Summary written when the review finishes (or aborts).

- `reviewedAt` (datetime, required) — Instant the review finished, in UTC.
- `totalItems` (integer, required) — Items in the batch.
- `validItems` (integer, required) — Items that passed every check.
- `invalidItems` (integer, required) — Items flagged `INVALID`; they block dispatch.
- `totalAmount` (string, required) — Amount in BRL as a decimal string with two places (`1234.56`).
- `validAmount` (string, required) — Amount in BRL as a decimal string with two places (`1234.56`).
- `balance` (PixBatchReviewBalance, required) — Available balance snapshot taken by the review.
- `limits` (list of PixBatchReviewLimit, required) — One entry per cashout window.
- `warnings` (list of string, optional) — Non-blocking notices (e.g. balance currently insufficient).
- `error` (string, optional) — Present only when the review aborted.

### PixBatchReviewBalance

Available balance snapshot taken by the review.

- `available` (string, required) — Amount in BRL as a decimal string with two places (`1234.56`).
- `sufficient` (boolean, required) — Whether `available` covers `validAmount`.
- `checked` (boolean, required) — False when the settlement bank did not answer; a warning is added.

### PixBatchReviewLimit

Comparison of the batch total with one cashout limit window.

- `window` (string, required) — Window label (`daily_out`, `nightly_out`, `monthly`).
- `enforced` (boolean, required) — Whether a ceiling is configured for this window.
- `limit` (string, required) — Amount in BRL as a decimal string with two places (`1234.56`).
- `used` (string, required) — Amount in BRL as a decimal string with two places (`1234.56`).
- `available` (string, required) — Amount in BRL as a decimal string with two places (`1234.56`).
- `sufficient` (boolean, required) — Whether `available` covers `validAmount` (always true when not enforced).

## Examples

**Response**

```json
{
  "items": [
    {
      "batchId": "pxb_3f9c2a1b7d4e5f60718293a4b5c6d7e8",
      "name": "Folha de setembro",
      "status": "PARTIAL_FAILED",
      "totalItems": 3,
      "totalAmount": "5436.85",
      "completedItems": 2,
      "failedItems": 1,
      "limits": {
        "maxItems": 50,
        "source": "default"
      },
      "createdAt": "2026-09-30T13:08:12Z",
      "updatedAt": "2026-09-30T13:12:40Z",
      "reviewedAt": "2026-09-30T13:09:30Z",
      "acknowledgedAt": "2026-09-30T13:10:00Z",
      "dispatchedAt": "2026-09-30T13:10:00Z",
      "completedAt": "2026-09-30T13:12:40Z"
    }
  ],
  "page": 1,
  "pageSize": 50,
  "totalItems": 1,
  "totalPages": 1,
  "hasNext": false
}
```

**SDK Code**

```python Pix_listPixBatches_example
import requests

url = "https://tenant.api.corpx.com/v1/accounts/accountId/pix/batches"

headers = {
    "X-Tenant-Id": "X-Tenant-Id",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Pix_listPixBatches_example
const url = 'https://tenant.api.corpx.com/v1/accounts/accountId/pix/batches';
const options = {
  method: 'GET',
  headers: {'X-Tenant-Id': 'X-Tenant-Id', Authorization: 'Bearer <token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Pix_listPixBatches_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://tenant.api.corpx.com/v1/accounts/accountId/pix/batches"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Tenant-Id", "X-Tenant-Id")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Pix_listPixBatches_example
require 'uri'
require 'net/http'

url = URI("https://tenant.api.corpx.com/v1/accounts/accountId/pix/batches")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Tenant-Id"] = 'X-Tenant-Id'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java Pix_listPixBatches_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://tenant.api.corpx.com/v1/accounts/accountId/pix/batches")
  .header("X-Tenant-Id", "X-Tenant-Id")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Pix_listPixBatches_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://tenant.api.corpx.com/v1/accounts/accountId/pix/batches', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'X-Tenant-Id' => 'X-Tenant-Id',
  ],
]);

echo $response->getBody();
```

```csharp Pix_listPixBatches_example
using RestSharp;

var client = new RestClient("https://tenant.api.corpx.com/v1/accounts/accountId/pix/batches");
var request = new RestRequest(Method.GET);
request.AddHeader("X-Tenant-Id", "X-Tenant-Id");
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Pix_listPixBatches_example
import Foundation

let headers = [
  "X-Tenant-Id": "X-Tenant-Id",
  "Authorization": "Bearer <token>"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://tenant.api.corpx.com/v1/accounts/accountId/pix/batches")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```