Skip to main content

Generate Pix Statement Export File

POST 
/v4/reports/pix-statement/exports
Description: Initiate a request to retrieve a pix statement file for the specified date range. If no date range is provided, the current date will be used. Use the returned file_id with the 'storage/files/:id/url' endpoint to get a URL for downloading the pix statement in CSV format.

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.

Body

required
    created_at_start date-time

    Start date for the statement (format: YYYY-MM-DD). Filters operations where transaction_created_at >= this date (inclusive).

    created_at_end date-time

    End date for the statement (format: YYYY-MM-DD). Filters operations where transaction_created_at < this date (exclusive).

    file_name string

    Custom file name for the generated report.

Responses​

Pix statement generation initiated successfully.

Schema
    file_id stringrequired

    Generated file ID.

    state stringrequired

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

    File state.

    created_at date-timerequired

    File created at.

Loading...