> 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. # Get a PIX batch and paginated items GET https://tenant.api.corpx.com/v1/accounts/{accountId}/pix/batches/{batchId} Returns one batch, its review summary (when reviewed), live statistics and one page of items. `status` and `reviewStatus` filter the item page. Poll this route or subscribe to `pix.batch.completed` for the terminal state; each item also emits the regular `pix.out.*` events. Reference: https://en.docs.api.corpx.com/baas/referencia/pix/get-pix-batch ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Request ### Path parameters - `accountId` (string, required) — Account identifier. - `batchId` (string, required) — PIX batch identifier (`pxb_…`) returned by the create endpoint. ### Query parameters - `status` (enum, optional) — Item execution status filter (`pending`, `processing`, `completed`, `failed`). - Allowed values: `pending`, `processing`, `completed`, `failed` - `reviewStatus` (enum, optional) — Item review status filter (`pending`, `ok`, `invalid`). - Allowed values: `pending`, `ok`, `invalid` - `page` (integer, optional, default: 1) — Item page number, starting at 1. - `pageSize` (integer, optional, default: 50) — Number of batch items per page. ### Headers - `X-Tenant-Id` (string, required) — Tenant context used for authorization and routing. ## Response ### 200 Batch, review summary, statistics and paginated items - `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. - `statistics` (PixBatchStatistics, required) — Live item counters and amounts. - `items` (list of PixBatchItem, required) — Current page of items. - `page` (integer, required) — Current item page. - `pageSize` (integer, required) — Requested item page size. - `totalPages` (integer, required) — Number of item pages. - `hasNext` (boolean, required) — Whether another item page exists. - `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. ## 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. ### 404 Not Found Error `pix_batch_not_found`. - `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 ### 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`). ### PixBatchStatistics Live item counters and amounts. - `total` (integer, required) — Items in the batch. - `pending` (integer, required) — Items not yet started. - `processing` (integer, required) — Items with a PIX out in flight. - `completed` (integer, required) — Items settled. - `failed` (integer, required) — Items that ended without settlement. - `reviewedOk` (integer, required) — Items that passed the review. - `invalid` (integer, required) — Items flagged by the review. - `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`). - `completedAmount` (string, required) — Amount in BRL as a decimal string with two places (`1234.56`). - `failedAmount` (string, required) — Amount in BRL as a decimal string with two places (`1234.56`). - `progressPercentage` (double, required) — `(completed + failed) / total × 100`; zero when total is zero. ### PixBatchItem One staged payment, its review outcome and its execution result. - `itemId` (string, required) — Batch-local item identifier (`pxi_…`) used by delete and receipt routes. - `line` (integer, required) — Stable order of this item inside the batch (CSV line order). - `identifier` (string, required) — Caller-owned identifier. - `mode` (enum, required) — How the receiver was given. - Allowed values: `KEY`, `BANK_ACCOUNT` - `amount` (string, required) — Amount in BRL as a decimal string with two places (`1234.56`). - `description` (string, required) — Free text sent with the PIX. - `status` (enum, required) — Execution state. - Allowed values: `PENDING`, `PROCESSING`, `COMPLETED`, `FAILED` - `reviewStatus` (enum, required) — Review outcome. - Allowed values: `PENDING`, `OK`, `INVALID` - `receiver` (PixBatchItemReceiver, required) — Receiver as staged (bank-account mode) or as resolved by the review (key mode). - `createdAt` (datetime, required) — Item staging instant, in UTC. - `updatedAt` (datetime, required) — Last item update, in UTC. - `reviewError` (PixBatchItemError, optional) — Stable code plus diagnostic text. - `error` (PixBatchItemError, optional) — Stable code plus diagnostic text. - `paymentId` (string, optional) — PIX out payment id once the item was prepared. - `endToEndId` (string, optional) — End-to-end id when settled. - `transactionId` (string, optional) — Settlement-bank transaction id when settled. - `completedAt` (datetime, optional) — Settlement instant. ### 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. ### 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. ### PixBatchItemReceiver Receiver as staged (bank-account mode) or as resolved by the review (key mode). - `name` (string, optional) — Receiver name. - `documentNumber` (string, optional) — Receiver document; masked when it came from DICT. - `keyType` (string, optional) — Key type (key mode). - `key` (string, optional) — PIX key (key mode). - `bankIspb` (string, optional) — Receiver bank ISPB. - `bankCode` (string, optional) — Receiver bank COMPE code. - `accountBranch` (string, optional) — Receiver branch (bank-account mode). - `accountNumber` (string, optional) — Receiver account number (bank-account mode). - `accountType` (string, optional) — Receiver account type (bank-account mode). ### PixBatchItemError Stable code plus diagnostic text. - `errorCode` (string, required) — Stable machine-readable code. - `message` (string, required) — Human-readable diagnostic; do not branch on it. ### 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 { "batchId": "pxb_3f9c2a1b7d4e5f60718293a4b5c6d7e8", "name": "Folha de setembro", "status": "PARTIAL_FAILED", "totalItems": 2, "totalAmount": "3936.85", "completedItems": 1, "failedItems": 1, "limits": { "maxItems": 50, "source": "default" }, "createdAt": "2026-09-30T13:08:12Z", "updatedAt": "2026-09-30T13:12:40Z", "statistics": { "total": 2, "pending": 0, "processing": 0, "completed": 1, "failed": 1, "reviewedOk": 2, "invalid": 0, "totalAmount": "3936.85", "validAmount": "3936.85", "completedAmount": "1436.85", "failedAmount": "2500.00", "progressPercentage": 100 }, "items": [ { "itemId": "pxi_8a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d", "line": 1, "identifier": "folha-set-001", "mode": "KEY", "amount": "1436.85", "description": "Pagamento setembro", "status": "COMPLETED", "reviewStatus": "OK", "receiver": { "name": "MARIA DA SILVA", "documentNumber": "***.456.789-**", "keyType": "CPF", "key": "12345678909", "bankIspb": "60701190", "bankCode": "341" }, "createdAt": "2026-09-30T13:08:40Z", "updatedAt": "2026-09-30T13:12:01Z", "paymentId": "pay_1f2e3d4c-5b6a-4798-8a9b-0c1d2e3f4a5b", "endToEndId": "E5087192120260930131200abcdef0123", "transactionId": "9f8e7d6c-5b4a-4321-8765-43210fedcba9", "completedAt": "2026-09-30T13:12:01Z" }, { "itemId": "pxi_1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f", "line": 2, "identifier": "folha-set-002", "mode": "BANK_ACCOUNT", "amount": "2500.00", "description": "Fornecedor", "status": "FAILED", "reviewStatus": "OK", "receiver": { "name": "EMPRESA EXEMPLO LTDA", "documentNumber": "12345678000195", "bankIspb": "60701190", "bankCode": "341", "accountBranch": "0001", "accountNumber": "123456", "accountType": "CHECKING" }, "createdAt": "2026-09-30T13:08:40Z", "updatedAt": "2026-09-30T13:12:40Z", "error": { "errorCode": "account_not_found", "message": "Conta destino não localizada" }, "paymentId": "pay_7a6b5c4d-3e2f-4a1b-9c8d-7e6f5a4b3c2d" } ], "page": 1, "pageSize": 50, "totalPages": 1, "hasNext": false, "review": { "reviewedAt": "2026-09-30T13:09:30Z", "totalItems": 2, "validItems": 2, "invalidItems": 0, "totalAmount": "3936.85", "validAmount": "3936.85", "balance": { "available": "12000.00", "sufficient": true, "checked": true }, "limits": [ { "window": "daily_out", "enforced": true, "limit": "50000.00", "used": "1200.00", "available": "48800.00", "sufficient": true }, { "window": "monthly", "enforced": false, "limit": "0.00", "used": "0.00", "available": "0.00", "sufficient": true } ] }, "reviewedAt": "2026-09-30T13:09:30Z", "acknowledgedAt": "2026-09-30T13:10:00Z", "dispatchedAt": "2026-09-30T13:10:00Z", "completedAt": "2026-09-30T13:12:40Z" } ``` **SDK Code** ```python Pix_getPixBatch_example import requests url = "https://tenant.api.corpx.com/v1/accounts/accountId/pix/batches/batchId" headers = { "X-Tenant-Id": "X-Tenant-Id", "Authorization": "Bearer " } response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript Pix_getPixBatch_example const url = 'https://tenant.api.corpx.com/v1/accounts/accountId/pix/batches/batchId'; const options = { method: 'GET', headers: {'X-Tenant-Id': 'X-Tenant-Id', Authorization: 'Bearer '} }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Pix_getPixBatch_example package main import ( "fmt" "net/http" "io" ) func main() { url := "https://tenant.api.corpx.com/v1/accounts/accountId/pix/batches/batchId" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("X-Tenant-Id", "X-Tenant-Id") req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Pix_getPixBatch_example require 'uri' require 'net/http' url = URI("https://tenant.api.corpx.com/v1/accounts/accountId/pix/batches/batchId") 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 ' response = http.request(request) puts response.read_body ``` ```java Pix_getPixBatch_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://tenant.api.corpx.com/v1/accounts/accountId/pix/batches/batchId") .header("X-Tenant-Id", "X-Tenant-Id") .header("Authorization", "Bearer ") .asString(); ``` ```php Pix_getPixBatch_example request('GET', 'https://tenant.api.corpx.com/v1/accounts/accountId/pix/batches/batchId', [ 'headers' => [ 'Authorization' => 'Bearer ', 'X-Tenant-Id' => 'X-Tenant-Id', ], ]); echo $response->getBody(); ``` ```csharp Pix_getPixBatch_example using RestSharp; var client = new RestClient("https://tenant.api.corpx.com/v1/accounts/accountId/pix/batches/batchId"); var request = new RestRequest(Method.GET); request.AddHeader("X-Tenant-Id", "X-Tenant-Id"); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift Pix_getPixBatch_example import Foundation let headers = [ "X-Tenant-Id": "X-Tenant-Id", "Authorization": "Bearer " ] let request = NSMutableURLRequest(url: NSURL(string: "https://tenant.api.corpx.com/v1/accounts/accountId/pix/batches/batchId")! 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() ```