Skip to main content

Generate Operation Statement Product Export File

POST 
/v1/reports/operation-statement-product/exports
Description: Initiate a request to retrieve an operation 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 operation 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-lang string

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

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

    x-product-uuid stringrequired

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

    Possible values: [transaction_created_at]

    Default value: transaction_created_at

    Page sort attribute.

    order string

    Possible values: [asc, desc]

    Default value: desc

    Page order.

    filter_type string

    Possible values: [currency_symbol, merchant_id, topic, value]

    Filter type.

    • currency_symbol: Currency symbol.
    • merchant_id: Merchant ID.
    • value: Operation value.
    • topic: Transaction type topic.

    filter_text string

    Filter Text.

    • Note: Valid transaction type topics:
      • CARD: Card transactions.
      • PIX: PIX transactions.
      • TED: TED transactions.
      • BANK_BILLET: Bank billet transactions.
      • CRYPTO: Cryptocurrency transactions.
      • P2P: P2P transactions.
      • OTHERS: Other types of transactions.

    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).

Responses​

Operation statement product export generated successfully.

Schema
    file_id stringrequired

    Generated file ID.

    file_state stringrequired

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

    File state.

    created_at date-timerequired

    File created at.

Loading...