Skip to main content

Generate Pix Statement Product Export File

POST 
/v1/reports/pix-statement-product/exports
Description: Initiate a request to retrieve a pix statement product file for the specified date range. Use the returned file_id with the 'storage/files/:id/url' endpoint to get url for download the pix statement in CSV format.

Request​

Header Parameters

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

    x-product-uuid stringrequired

    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
    sort string

    Possible values: [operation_created_at]

    Default value: operation_created_at

    Page sort attribute.

    order string

    Possible values: [asc, desc]

    Default value: desc

    Page order.

    filter_type string

    Possible values: [beneficiary_document, owner_document, end_to_end_id, merchant_id, txid]

    Filter type.

    • beneficiary_document: Beneficiary Document.
    • owner_document: Owner Document.
    • end_to_end_id: End To End ID.
    • merchant_id: Merchant ID.
    • txid: Tx ID.

    filter_text string

    Filter text.

    created_at_start date

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

    created_at_end date

    End date for the statement (format: YYYY-MM-DD). Filters operations where operation_created_at <= this date (inclusive).

Responses​

Pix statement product export generated successfully.

Schema
    file_id stringrequired

    Generated file ID.

    file_state stringrequired

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

    File state.

    created_at date-timerequired

    File created at.

Loading...