Export Account Statements

Export Account Statements

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

Creates a report of Account Statements that can be downloaded later. The initial status is AWAITING_PROCESS while our system is getting all the necessary data that you have requested. In "Get Exported Files" you will know when a report is ready to download when the status changes to CREATED.

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"
}