Skip to main content

Generate Account Statement Export File

POST 
/v1/reports/account-statement/exports
Description: Request the BRL account statement file of the wallet, one transaction per row, with the balances at the start and at the end of the period. The period must be within the same month. The file is generated asynchronously: use the returned file_id with the 'storage/files/:id/url' endpoint to download it once ready. If the generation fails, the file state becomes ERROR.

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-product-uuid string

    UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.

    x-product-target-user-uuid string

    UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires x-product-uuid.

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

Body

required
    created_at_start date-time

    Period start. Filters transactions where transaction_created_at >= this date. Defaults to the start of the month.

    created_at_end date-time

    Period end. Filters transactions where transaction_created_at < this date (exclusive). Defaults to the start of the next month.

    local_timezone_start number

    Local timezone to validate start date.

    local_timezone_end number

    Local timezone to validate end date.

    type_extension string

    Possible values: [CSV, OFX, PDF]

    Default value: CSV

    File format.

Responses​

Account statement export requested successfully.

Schema
    file_id stringrequired

    Generated file ID.

    file_state stringrequired

    Possible values: [PENDING, WAITING_UPLOAD, READY, ERROR, ABORTED]

    Generated file state.

    created_at date-timerequired

    File created at.

Loading...