Skip to main content

List Operations

GET 
/v1/operations

Retrieve a list of the user's operations.

Request​

Query Parameters

    page number

    Default value: 1

    Page number.

    size number

    Possible values: <= 100

    Default value: 20

    Page size. Max size is 100.

    sort string

    Possible values: [created_at]

    Page sort attribute.

    order string

    Possible values: [asc, desc]

    Default value: asc

    Page order.

    currency_symbol string

    Operation currency symbol.

    transaction_tag string

    Operation Transaction tag.

    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

    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.

Responses​

The operations returned successfully.

Schema
    page numberrequired

    Page number.

    page_size numberrequired

    Page size.

    page_total numberrequired

    Page total.

    total numberrequired

    Total of elements.

    data object[]required

    Operations data.

  • Array [
    • id stringrequired

    Operation id.

    fee number

    Operation fee in cents.

    state stringrequired

    Possible values: [accepted, declined, undone, pending, reverted, waiting_accept, waiting_revert, waiting_ledger, waiting_credit, waiting_debit, waiting_accept_credit]

    Operation state.

    description stringrequired

    Operation description.

    value number

    Operation value in cents.

    created_at date-timerequired

    Operation created at.

    reverted_at date-time

    Operation reverted at.

    currency_id numberrequired

    Currency Id.

    currency_symbol stringrequired

    Currency symbol.

    transaction_id numberrequired

    Transaction id.

    transaction_tag stringrequired

    Transaction tag.

    owner_wallet_uuid string

    Operation owner wallet.

    beneficiary_wallet_uuid string

    Operation beneficiary wallet uuid.

    operation_ref_id string

    Operation ref id.

    chargeback_id string

    Operation chargeback id.

  • ]
Loading...