List Wallet Accounts

GET 
/operations/wallet-accounts

Retrieve a list of wallet accounts belonging to a user. Optional filter parameters can be used to refine your search.

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: [currencySymbol]

Page sort attribute.

order string

Possible values: [asc, desc]

Default value: asc

Page order.

currency_symbol string

WalletAccount currency symbol.

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 requisition. All requisitions must have an identifier.

Responses

200

The wallet accounts returned successfully.

application/json

Schema

Schema

page numberrequired

Page number.

page_size numberrequired

Page size.

page_total numberrequired

Page total.

total numberrequired

Total of elements.

data object[]required
WalletAccounts data.
Array [
balance numberrequired
Value in cents.
pending_amount number
Value in cents.
currency_id numberrequired
The currency id.
currency_title string
The currency title.
currency_decimal numberrequired
The currency decimal.
currency_symbol stringrequired
The currency symbol.
currency_symbol_align stringrequired
Possible values: [left, right]
The currency symbol align.
]

Example (from schema)

{
  "page": 1,
  "page_size": 20,
  "page_total": 20,
  "total": 100,
  "data": [
    {
      "balance": 10000,
      "pending_amount": 5000,
      "currency_id": 21,
      "currency_title": "string",
      "currency_decimal": 8,
      "currency_symbol": "BRL",
      "currency_symbol_align": "right"
    }
  ]
}

400

If any required params are missing or has invalid format or type.

401

User authentication failed.

422

If any required params are missing or has invalid format or type.

Loading...