Skip to main content

Generate Transaction Summary Product export file

POST 
/v1/reports/transaction-summary-product/exports
Tag: api-baas-post-report-transaction-summary-product-exportDescription: Initiates CSV export for the same filters as GET reports/transaction-summary-product. Use the returned file_id with storage/files/:id/url to download.

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

    Currency symbol (e.g. BRL).

    transaction_type_tag string

    Transaction type tag.

    format string

    Possible values: [CSV, PDF, XML]

    File format extension (CSV, PDF or XML). Defaults to CSV.

    movement_date_start date

    Movement date start (YYYY-MM-DD).

    movement_date_end date

    Movement date end (YYYY-MM-DD).

    sort string

    Possible values: [movement_date]

    Default value: movement_date

    Page sort attribute.

    order string

    Possible values: [asc, desc]

    Default value: asc

    Page order.

Responses​

Transaction summary 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...