Skip to main content

List Account Statement

GET 
/v1/reports/account-statement
Description: Retrieve the BRL account statement of the wallet, one transaction per row, oldest first, with the balances at the start and at the end of the period. The period must be within the same month. If no date is specified, the current month is used.

Request​

Query Parameters

    created_at_start date-time

    Period start. Filters transactions where transaction_created_at >= this date. Defaults to the start of the month.

    created_at_end date-time

    Period end. Filters transactions where transaction_created_at < this date (exclusive). Defaults to the start of the next month.

    local_timezone_start number

    Local timezone to validate start date.

    local_timezone_end number

    Local timezone to validate end date.

    page_state string

    Page state returned by the previous page.

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

    x-lang string

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

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

Responses​

The account statement returned successfully.

Schema
    initial_balance numberrequired

    Account balance at the start of the period, in cents.

    final_balance numberrequired

    Account balance at the end of the period, in cents.

    data object[]required

    Transactions of the page, oldest first.

  • Array [
    • operation_id stringrequired

    Operation ID.

    transaction_created_at date-timerequired

    Transaction date.

    transaction_type_tag stringrequired

    Transaction type tag.

    description stringrequired

    Transaction type title followed by the counterpart name.

    third_part_document string

    Counterpart document.

    transfer_description string

    Message sent with the transfer.

    third_part_bank_name string

    Counterpart bank name.

    third_part_bank_ispb string

    Counterpart bank ISPB.

    third_part_account_number string

    Counterpart account number.

    third_part_branch string

    Counterpart branch.

    end_to_end_id string

    End to end ID.

    value numberrequired

    Transaction value in cents. Debits are negative.

    balance number

    Account balance after the transaction, in cents.

  • ]
    • has_next_page booleanrequired

    Whether there is a next page.

    page_state string

    Page state to request the next page.

Loading...