Retrieve a P2P Batch Item

Returns a paginated list of P2P batches

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Retrieves all P2P batches.
Each batch represents a bulk P2P transfer request previously created via POST /transactions/p2p/batch/{bank_account_uuid}.

Query parameters

ParamTypeDefaultDescription
limitinteger1000Records per page. Max 10000.
pageinteger1Page number (1-based).
initial_datestringYYYY-MM-DD or YYYY-MM-DD HH:MM:SS. Filter by created_at.
final_datestringSame format as initial_date.
searchstringFree-text search (LIKE) over batch description and code.
code_statusintegerFilter by transaction status code. See table below.
bank_account_uuidUUIDRestrict to batches whose items belong to the given origin account.

Status codes (code_status)

CodeStatus
1IN_PROCESS
2APPROVED
3CANCELED
4EXPIRED
5UNDER_REVIEW
6PENDING

Success response — 200 OK

{
  "return": true,
  "message": "success",
  "data": {
    "code": "772732a5-3d8c-4c8f-83f8-dfbf43dac5c6",
    "item_status": "APPROVED",
    "code_item_status": 2,
    "reason": "example",
    "description": "example item",
    "amount": 100.00,
    "origin_account": "4700000",
    "receiver_account": "0770000",
    "transaction_code_payer": "ccb776da-7d1d-476f-8b3d-5f351a060429",
    "transaction_code_receiver": "7a8a6657-faba-4d8f-a064-0772405d27d9"
  }
}

Field reference

FieldTypeDescription
codeUUIDItem identifier.
item_statusstringHuman-readable status of the item. See status codes.
code_item_statusintegerNumeric status code matching the table above.
reasonstringFailure reason returned by the processing system. Empty when the item succeeded.
descriptionstringOptional description set on the item at creation. Empty string when not provided.
amountnumber (BRL)Transfer amount for this item.
origin_accountstringAccount number that originated the transfer.
receiver_accountstringAccount number that received the transfer.
transaction_code_payerstringTransaction identifier on the payer side.
transaction_code_receiverstringnull

Error responses

StatusmessageWhen
400batch not foundNo batches match the filters.
400statement query with limit below \1` or over `10000` registries per page is not allowed`limit > 10000.
406bank account not foundbank_account_uuid does not belong to the company.
401Missing/invalid Bearer token.
Path Params
string
required

The code of the parent batch

string
required

The code of the item within the batch

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json