Export Account Statements

Export Account Statements

POST {{Environment_URL}}/vendors/v1/charges/balance/export/:type

This endpoint creates an export job for your account statements. Instead of returning the data immediately, it starts an asynchronous process that prepares a file with your statement data. How it works:

1. You request an export and define filters (date range, transaction type, account, etc.).

2. The system starts processing your request.

3. The export status is initially set to AWAITING_PROCESS.

4. When the file is ready, the status changes to CREATED.

5. You can then download the file using the “List Exports” endpoint on "Download files exported" section in this documentation

You can export statements in:

• XLSX

• CSV

Use this endpoint when you need to:

• Generate accounting or financial reports

• Export large volumes of statement data

• Share data with finance or compliance teams

This approach avoids timeouts and allows you to export large datasets safely

Headers

Name	Value
Authorization	Bearer <token>

Query Params

Key	Description	Required	Data Type	Example
id	Charge or Batch ID	false	String	ch_74pq9wxyunl6zrsediovay2hjk
account	User Account ID. Primarily used for comm.PIX Users (Account Type)	false	String	acc_48qpvel2xn9us51qqb3whysrl
financialId	Batch ID. Used to find the Charges linked to specified Batch	false	String	fin_48qpvel2xn9us51qqb3whysrl
action	Transaction type action referring the money path	false	String	PAYIN PAYOUT PAYIN_REFUND
createdAtStart	Lists based on date interval. createdAtStart must be used with createdAtEnd	false *	String	2025-01-01
createdAtEnd	Lists based on date interval. createdAtEnd must be used with createdAtStart	false *	String	2025-02-01

Path Params

Key	Description	Required	Example
type	Document can be exported in XLSX or CSV	true	xlsx (or csv)

Response

200 - OK

{
    "id":"rpt_01jrjhk3zvexk0qmdx1xt0vem0",
    "status":"AWAITING_PROCESS"
}