Export Transactions

Export Transactions

GET{{Environment_URL}}/vendors/v1/charges/export/:type

This endpoint is responsible for initiating a new transaction export.

• You can specify the file format (XLSX or CSV).

• Filters can be applied to define which charges should be included in the export.

Typical use case: when a user needs to generate a file of transactions for reporting, analysis, or integration with external systems.

Headers

Name	Value
Authorization	Bearer <token>

Path Params

Name	Type	Description	Value
type	string	Possible values: xlsx or csv	xlsx

Query Params

Name	Description	Value
limit	Documents per page ∙ Min 15 | Max 100 | Default 15	15
id	Charge ID	ch_01k5cp4wcz18h06xjb60qtdtk8
page	Page number	0
status	Operation status ∙ CREATED | AWAITING | PAID | REFUNDED | CANCELED	CREATED
rangeStart	Initial interval for operation value ∙ Must be used with rangeEnd	10000
rangeEnd	Final interval for operation value ∙ Must be used with rangeStart	15000
createdAtStart	Initial cretedAt date interval ∙ Must be used with createdAtEnd	YYYY-MM-DD
createdAtEnd	Initial cretedAt date interval ∙ Must be used with createdAtStart	YYYY-MM-DD
updatedAtStart	Initial updateAt date interval ∙ Must be used with updatedAtEnd	YYYY-MM-DD
updatedAtEnd	Final updatedAt date interval ∙ Must be used with updatedAtStart	YYYY-MM-DD
currency	Currency used by vendor (USD, EUR, ...)	EUR
treasuryPending	Boolean indicating whether the charge is pending Treasury review	false
financePending	Boolean indicating whether the charge is pending Finance review	true
awaitingRelease	Boolean indicating whether the charge is awaiting release/withdrawal	false
creditFinancialStatus	Current credit status related to Finance	COMPLETED
payerId	National document number of the payer (CPF or CNPJ).	111.222.333-44
payerName	Full name of the payer	John Doe

Response

200 - OK

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