Skip to main content

List Operation Statement Data

GET 
/reports/operation-statement
deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Retrieve a list of operation statement data for the user. When filtering by date, ensure that the date range is within the same month. If no date has been specified in the filters, the statement will be generated for the current month.

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.

    • currency_symbol: Currency symbol.
    • value: Operation value.
    • topic: Transaction type topic.

    filter_text string

    Filter Text.

    • Note: Valid transaction type topics:
      • 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.

    created_at_end date-time

    Operation created at end.

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

    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.

    previous_balance number

    Previous 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, DEPORECEIVE, TEDRECEIVE, DEBITTRANSACTION, DEBITCBK, TEDFAILURE, TEDUNDO, BBPCBK, TEDRECCBK, DEPRECCBK, BILLETFAILURE, 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.

  • ]
    • has_next_page booleanrequired

    Has next page.

    page_state string

    Page state.

Loading...