Skip to main content

List Operation Statement Data By Product

GET 
/v2/reports/operation-statement-product
Tag: api-baas-get-all-report-operation-statement-productDescription: Retrieve operation statement data filtered by product. Date range must be within the same month. If no dates specified, defaults to current day. When using filters, both filter_type and filter_text must be provided together.

Request​

Query Parameters

    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. Must be provided if filter_text is used.

    • currency_symbol: Currency symbol.
    • merchant_id: Merchant ID.
    • value: Operation value (must be a positive number).
    • topic: Transaction type topic.

    filter_text string

    Filter Text. Required if filter_type is provided.

    • When using filter_type=value: Must be a positive number (e.g. "100" or "15.50").
    • When using filter_type=currency_symbol: Use currency symbol (e.g. "BRL", "USD").
    • When using filter_type=topic: Use valid transaction type topic:
      • 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.

    page_state string

    Previous page state.

    transaction_created_at_start date-time

    Transaction created at start. If not provided, defaults to the beginning of the current day (00:00:00).

    transaction_created_at_end date-time

    Transaction created at end. If not provided, defaults to the end of the current day (23:59:59).

    page_size number

    Page size.

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

Responses​

The operation statement data returned successfully.

Schema
    data object[]required

    Report operation statement data.

  • Array [
    • id stringrequired

    ID.

    user_id stringrequired

    User ID.

    wallet_id stringrequired

    Wallet ID.

    product_id stringrequired

    Product ID.

    year_month stringrequired

    Year Month.

    topic stringrequired

    Topic.

    operation_type stringrequired

    Operation Type.

    operation_id stringrequired

    Operation ID.

    operation_created_at date-timerequired

    Operation Created At.

    operation_created_at_us string

    Operation Created At Microseconds.

    operation_reverted_at date-time

    Operation Reverted At.

    operation_updated_at date-time

    Operation Updated At.

    transaction_id stringrequired

    Transaction ID.

    transaction_created_at date-timerequired

    Transaction Created At.

    fee number

    Fee.

    value numberrequired

    Value.

    description string

    Description.

    operation_ref_id string

    Operation Reference ID.

    chargeback_id string

    Chargeback ID.

    merchant_id string

    Merchant ID.

    currency_id numberrequired

    Currency ID.

    currency_symbol stringrequired

    Currency Symbol.

    transaction_type_id numberrequired

    Transaction Type ID.

    transaction_type_tag stringrequired

    Transaction Type Tag.

    owner_id string

    Owner ID.

    owner_full_name string

    Owner Full Name.

    owner_document string

    Owner Document.

    owner_wallet_account_id string

    Owner Wallet Account ID.

    beneficiary_id string

    Beneficiary ID.

    beneficiary_full_name string

    Beneficiary Full Name.

    beneficiary_document string

    Beneficiary Document.

    beneficiary_wallet_account_id string

    Beneficiary Wallet Account ID.

    previous_balance number

    Previous Balance.

    updated_balance number

    Updated Balance.

  • ]
    • has_next_page booleanrequired

    Has next page.

    page_state string

    Page state.

Loading...