Retrieve P2P Batches

get

https://api.staging.bancocdc.com.br/transactions/p2p/batch

Returns a paginated list of P2P batches

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query parameters

All parameters are optional.

Param	Type	Default	Description
`limit`	integer	`1000`	Records per page. Maximum `10000`.
`page`	integer	`1`	Page number (1-based).
`initial_date`	string	—	Lower bound for `created_at`. Format: `YYYY-MM-DD` or `YYYY-MM-DD HH:MM:SS`.
`final_date`	string	—	Upper bound for `created_at`. Same format as `initial_date`.
`search`	string	—	Free-text `LIKE` search over batch `description` and `code`.
`code_status`	integer	—	Filter by transaction status code. See status codes.
`batch_code`	UUID	—	Restrict the result to a single batch by its `code`.
`bank_account_code`	UUID	—	Restrict the result to batches whose items originate from the given bank account.

Status codes

Use the numeric value in code_status to filter, and expect the same value in
code_transaction_status of each row.

Code	Status	Meaning
`1`	`IN_PROCESS`	Batch is still being processed.
`2`	`APPROVED`	All items processed successfully.
`3`	`CANCELED`	Batch was canceled.
`4`	`EXPIRED`	Batch expired before processing.
`5`	`UNDER_REVIEW`	Held for manual review.
`6`	`PENDING`	Awaiting authorization.

Success response — `200 OK`

{
  "return": true,
  "message": "success",
  "page": 1,
  "total_pages": 3,
  "registries": 25,
  "total_registries": 67,
  "data": [
    {
      "code": "5b1f8c2e-9a7d-4c3b-aef5-2d6e1f3a9b40",
      "batch_size": 100,
      "qty_successes": 98,
      "qty_errors": 2,
      "total_amount": 9850.00,
      "description": "folha-de-pagamento mai/26",
      "transaction_status": "APPROVED",
      "code_transaction_status": 2,
      "created_at": "2026-05-22 14:32:11"
    }
  ]
}

Envelope fields

Field	Description
`return`	Always `true` on success.
`message`	`"success"` on a successful query.
`page`	Current page number.
`total_pages`	Total number of pages for the current filter set.
`registries`	Number of records in the current page.
`total_registries`	Total number of records across all pages.
`data`	Array of batch summaries — see field reference below.

Field reference — batch summary

Field	Type	Description
`code`	UUID	Batch identifier.
`batch_size`	integer	Total number of items in the batch.
`qty_successes`	integer	Items processed successfully.
`qty_errors`	integer	Items that failed.
`total_amount`	number (BRL)	Sum of all item values.
`description`	string	Optional batch description set at creation. Empty string when not provided.
`transaction_status`	string	Human-readable status. See status codes.
`code_transaction_status`	integer	Numeric status code matching the table above.
`created_at`	string	Batch creation timestamp (server timezone, `YYYY-MM-DD HH:MM:SS`).

Error responses

Status	`message`	When
`400`	`batch not found`	No batches match the filters.
`400`	`statement query with limit below \`1` or over `10000` registries per page is not allowed`	`limit > 10000`.
`406`	`bank account not found`	`bank_account_code` does not belong to the company.
`401`	—	Missing or invalid Bearer token.

Notes

Pagination metadata (page, total_pages, registries, total_registries) is always present, even when filtering by batch_code returns a single row.
This endpoint never includes the items array. To retrieve items, use the single-batch endpoint.
bank_account_code resolves the account internally before filtering, which costs one extra lookup — prefer batch_code when you already know it.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json