Skip to main content

Generate Daily Balance Summary Detailed Export File

POST 
/v1/operations/balance/daily-summary-detailed/export
Description: Initiate a request to retrieve a daily balance summary detailed file for the specified date range. Use the returned file_id with the 'storage/files/:id/url' endpoint to get url for download the daily balance summary detailed in CSV, PDF or XML 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

    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.

Body

required
    sort string

    Possible values: [movement_date]

    Default value: movement_date

    Page sort attribute.

    order string

    Possible values: [asc, desc]

    Default value: asc

    Page order.

    movement_date_start date-timerequired

    Movement date start for the daily summary (YYYY-MM-DD).

    movement_date_end date-timerequired

    Movement date end for the daily summary (YYYY-MM-DD).

    currency_symbol stringrequired

    The currency symbol.

    format string

    Possible values: [CSV, PDF, XML]

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

Responses​

Daily balance summary detailed generated successfully.

Schema
    file_id stringrequired

    Generated file ID.

    state stringrequired

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

    File state.

    created_at date-timerequired

    File created at.

Loading...