Skip to main content

List Operation Statement Data By Product

GET 
/v1/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: [operation_created_at]

    Default value: operation_created_at

    Page sort attribute.

    order string

    Possible values: [asc, desc]

    Default value: desc

    Page order.

    filter_type string

    Possible values: [currency_symbol, topic, value]

    Filter type. Must be provided if filter_text is used.

    • currency_symbol: Currency symbol.
    • 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.

    created_at_start date-time

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

    created_at_end date-time

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

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

    Operation ID.

    state stringrequired

    Possible values: [accepted, declined, undone, pending, reverted, waiting_accept, waiting_revert]

    State.

    fee number

    Fee.

    value numberrequired

    Value.

    updated_balance number

    Updated balance.

    description string

    Description.

    created_at date-timerequired

    Operation creation date.

    reverted_at date-time

    Operation reverted at.

    currency_id numberrequired

    Currency ID.

    currency_symbol stringrequired

    Currency symbol.

    transaction_type_id numberrequired

    Transaction type ID.

    transaction_type_tag stringrequired

    Possible values: [P2PBT, WITHDRAW, PIXCHANGE, PIXDEVREC, PIXDEVSEND, PIXREC, PIXREFUND, PIXREFUNDDEV, PIXSEND, PIXSENDSELF, PIXWITHDRAWL, TED, CONV, BTCSEND, BTCRECEIVE, BBP, BBD, DEPORECEIVE, TEDRECEIVE, DEBITTRANSACTION, DEBITCBK, TEDFAILURE, TEDUNDO, TEDRECCBK, DEPRECCBK, DOCRECEIVE, PIXRECEIVE, WITHDRAWCBK, CASHBACK, CASHBACKCBK, FORFEITURE, DBTCARDCRED, ACTCLOSURE, REFREWARD, EXTRACREDIT, SALECREDCARD, SALEDEBTCARD, PIXWITHDRAWAL, ADMCRYPTOSEND, ADMCRYPTOREC, P2PBTCTP, P2PBTCTC, P2PTP, P2PTC, CBK, P2MTP, SP, TEDTRANSFERSELF, TEDDEVREC, PIXSENDRESTRICTED]

    Transaction type tag.

    transaction_type stringrequired

    Possible values: [C, D]

    Transaction type.

    owner_wallet_account_uuid string

    Owner wallet account ID.

    beneficiary_wallet_account_uuid string

    Beneficiary wallet account ID.

    operation_ref_id string

    Operation reference ID.

    chargeback_id string

    Chargeback ID.

    product_id stringrequired

    Product ID.

  • ]
    • has_next_page booleanrequired

    Has next page.

    page_state string

    Page state.

Loading...