Skip to main content

Account Extract

Retrieves the statement of financial transactions for the account.

Making Request

The call must be made using the GET method.

GET/v1/account/extract

Filter Parameters (Query Params)

PARAMETERDESCRIPTIONTYPEREQUIRED
start_dateInitial date of the search periodSTRING
datetime format YYYY-mm-dd
Yes
end_dateEnd date of the search periodSTRING
datetime format YYYY-mm-dd
Yes
register_typeFilter by transaction type (credit or debit)STRINGNo
pagePage number for pagination (default is 1)INTEGERNo

[!IMPORTANT] The maximum allowed interval between start_date and end_date is 31 days.

Success

In case of success, a HTTP 200 – OK status is returned, containing the data as shown below:

HTTP 200 Response Body - Example
{
"extract": [
{
"register_date": "2026-07-14T09:00:00.000-03:00",
"register_type": "credit",
"description": "Pix received",
"value_cents": 1000,
"operation_id": "op_12345"
}
],
"meta": {
"current_page": 1,
"total_pages": 1,
"total_items_amount": 1
}
}

Errors

In case of errors or invalid parameters (such as an interval greater than 31 days), a JSON with the error/errors attribute specifying the reason why the operation was invalidated will be returned.

HTTP 400 Response Body - Example
{
"error": "end_date max interval: 31 days"
}