Generate Pix Statement Export File
POSTDescription: Initiate a request to retrieve a pix statement file for the current date. Use the returned file_id with the 'storage/files/:id/url' endpoint to get url for download the pix statement in CSV format./v1/reports/pix-statement/exports
Request
Header Parameters
x-wallet-uuid string
Sender Wallet UUID (if empty, your default Wallet UUID will be settled)
nonce stringrequired
The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.
x-lang string
Possible values: [pt-BR
, en-US
]
Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.
x-product-uuid string
The product ID is a UUID (v4) used to identify the Z.ro product configuration.
x-product-target-user-uuid string
The product target user ID is a UUID (v4) used to identify what user account this request must be executed. Require: x-product-uuid.
Responses
- 201
- 400
- 401
- 422
Pix statement generated successfully.
- application/json
- Schema
- Example (from schema)
Schema
file_id stringrequired
Generated file ID.
created_at date-timerequired
File created at.
{
"file_id": "f6e2e084-29b9-4935-a059-5473b13033aa",
"created_at": "2025-04-25T20:46:12.510Z"
}
If any required params are missing or has invalid format or type.
User authentication failed.
If any required params are missing or has invalid format or type.
Loading...