Get wallet summary

GET /api/wallets/wallets/{id}/summary

Try it

Get wallet summary

cURL

curl --request GET \
  --url http://localhost/api/wallets/wallets/{id}/summary \
  --header 'Authorization: Bearer <token>'

200

{
  "data": {
    "balances": [
      {
        "name": "<string>",
        "assets": {},
        "expiresAt": "2023-11-07T05:31:56Z",
        "priority": 123
      }
    ],
    "availableFunds": {},
    "expiredFunds": {},
    "expirableFunds": {},
    "holdFunds": {}
  }
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id · string · required

Response

200

application/json

Wallet summary

data · object · required

Show child attributes

data. balances · object[] · required

Show child attributes

data.balances. name · string · required

data.balances. assets · object · required

Show child attributes

data.balances.assets. {key} · integer<bigint>

data.balances. expiresAt · string<date-time> | null

data.balances. priority · integer<bigint>

data. availableFunds · object · required

Show child attributes

data.availableFunds. {key} · integer<bigint>

data. expiredFunds · object · required

Show child attributes

data.expiredFunds. {key} · integer<bigint>

data. expirableFunds · object · required

Show child attributes

data.expirableFunds. {key} · integer<bigint>

data. holdFunds · object · required

Show child attributes

data.holdFunds. {key} · integer<bigint>