List PIX batches

GET

https://client.api.corpx.com/v1/accounts/:accountId/pix/batches

GET

/v1/accounts/:accountId/pix/batches

curl https://client.api.corpx.com/v1/accounts/accountId/pix/batches \
     -H "X-Content-SHA256: X-Content-SHA256" \
     -H "X-Request-Signature: X-Request-Signature" \
     -H "X-Request-Timestamp: X-Request-Timestamp" \
     -H "X-Tenant-Id: X-Tenant-Id" \
     -H "Authorization: Bearer <token>"

{
  "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
}

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

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

accountIdstringRequired

Account identifier.

Headers

X-Content-SHA256stringRequired

Lowercase hex SHA-256 of the body. An empty body hashes the empty string, so the header is always present. Mismatch returns 400 body_hash_mismatch.

Query parameters

statusstringOptional

Filter by batch status (draft, reviewing, reviewed, queued, processing, completed, partial_failed, failed).

pageintegerOptional>=1Defaults to 1

Page number, starting at 1.

pageSizeintegerOptional1-200Defaults to 50

Number of batches per page.

Response

Page of batch summaries

itemslist of objects

Batches in this page.

pageinteger

Current page.

pageSizeinteger

Requested page size.

totalItemsinteger

Total matching batches.

totalPagesinteger

Number of pages.

hasNextboolean

Whether another page exists.

Errors

403

Forbidden Error