Skip to main content

List transaction summary by product

GET 
/v1/reports/transaction-summary-product
Tag: api-baas-get-all-report-transaction-summary-productDescription: Returns paginated transaction summary rows for the authenticated user. Optional filters: wallet account, currency, transaction type, movement date range.

Request​

Query Parameters

    currency_symbol string

    Currency symbol (e.g. BRL).

    transaction_type_tag string

    Transaction type tag.

    movement_date_start date-time

    Movement date start (YYYY-MM-DD).

    movement_date_end date-time

    Movement date end (YYYY-MM-DD).

    page number

    Default value: 1

    Page number.

    page_size number

    Default value: 20

    Page size.

    sort string

    Possible values: [movement_date]

    Default value: movement_date

    Page sort attribute.

    order string

    Possible values: [asc, desc]

    Default value: asc

    Page order.

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.

Responses​

Transaction summary returned successfully.

Schema
    page numberrequired

    Current page.

    page_size numberrequired

    Page size.

    page_total numberrequired

    Total pages.

    total numberrequired

    Total rows.

    data object[]required

    Report rows.

  • Array [
    • id uuidrequired

    Row ID.

    movement_date daterequired

    Movement date.

    currency_symbol stringrequired

    Currency symbol.

    transaction_type_title stringrequired

    Transaction type title.

    transaction_type_tag stringrequired

    Transaction type tag.

    amount numberrequired

    Amount.

    transaction_count numberrequired

    Transactions count used in amount.

  • ]
Loading...