List balances of wallet

Retrieves all the balances in the wallet identified by the provided handle. If the wallet with the provided handle doesn't exist, API will return 404 error. Balances are returned as an integer number and have to be divided by factor assigned to balance symbol to get a decimal representation of the value.

GET
/wallets/{id}/balances

Authorization

AuthorizationBearer <token>

JWT signed by private key. The presence of this token is not mandatory. It becomes required through the configuration of authorization access rules that requires a token to grant access. Once sent, the token is validated for its format, signature and expiration, regardless of the presence of access rules.

In: header

Path Parameters

idaddress | luid

The unique identifier of the wallet record - it is luid or handle (address).

Query Parameters

page?object

Page query parameters

filter?object

Base filter parameters

Empty Object

Header Parameters

x-ledger?handle | luid

The unique identifier of ledger in context for multi tenant requests.

Response Body

fetch("http://localhost:3000/v2/wallets/string/balances?page.index=0&page.limit=20", {
  headers: {
    "x-ledger": "string"
  }
})

{
  "hash": "362c6ba85d1b140bb179c2aa2d718c7b9eaacfab79c3ac1f901c68b92fb8203f",
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "digest": "76c179951a90a5d4044a600b40e88f4e47dae11d47dedeafaaa8fe6b35d81979",
        "result": "4CFvYQnByav39vD2qihI2+iGDUTyxNit0pJG6uGBVUZMFMVMixlRMp27SENRQ2Yp/WlkMkNKp+4uTeKWq0JoCA==",
        "custom": {
          "moment": "2025-04-02T05:10:33.738Z"
        }
      }
    ],
    "moment": "2025-04-02T05:10:33.738Z"
  },
  "data": [
    {
      "hash": "9e7715f1c3f4c5d308d7d1a6a0234e2341f95dfc8c97cc9460b01c2c5a8d1322",
      "data": {
        "wallet": "bank-wallet",
        "symbol": "usd",
        "amount": 12345
      },
      "luid": "$wbl.-08478eGy_dZtugTG",
      "meta": {
        "proofs": [
          {
            "custom": {
              "moment": "2025-04-02T05:10:31.402Z"
            },
            "digest": "3252be7da9159d548fb51ad0a03eaf7607dc5c87b30146c5a419931fbe2d7106",
            "method": "ed25519-v2",
            "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
            "result": "56Y5s4NhFw6g5mXctdkZU6Xxg0SR4PXAyVH+iVJA3AVOyCdhxirOvJgWHsczVHZhKgjc8vYJYdQoVrt+4LKWBA=="
          },
          {
            "custom": {
              "moment": "2025-04-02T05:10:31.402Z"
            },
            "digest": "3252be7da9159d548fb51ad0a03eaf7607dc5c87b30146c5a419931fbe2d7106",
            "method": "ed25519-v2",
            "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
            "result": "56Y5s4NhFw6g5mXctdkZU6Xxg0SR4PXAyVH+iVJA3AVOyCdhxirOvJgWHsczVHZhKgjc8vYJYdQoVrt+4LKWBA=="
          }
        ],
        "moment": "2025-04-02T05:10:31.394Z"
      }
    }
  ],
  "page": {
    "index": 0,
    "limit": 20,
    "total": 1
  }
}

{
  "hash": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
  "data": {
    "reason": "auth.unauthorized",
    "detail": "Invalid token."
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "JdK8m5SqXGCiZ1TdXQbCe9ECqwL3Kg1UZxj4r9gT+cA=",
        "digest": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
        "result": "X2m5A9Yxh4FRPgj6wgJKN0dYrfgXSq3hx8UX1jnmJ7fVHtQCnAp8MepXDZQhNkMsJd7a9HPk96hmvYXTFcHzAw=="
      }
    ]
  }
}

{
  "hash": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
  "data": {
    "reason": "auth.forbidden",
    "detail": "Request is not authorized"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE=",
        "digest": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
        "result": "0G2gvSfBx6MwPT8ShBaiYx7zwa5Kqc4Cq3S3NXV1m5/ZPozoH/SUouuhi9sQU+f0yo0eX4ygH7PzE3PAdlxsCQ=="
      }
    ]
  }
}

{
  "hash": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
  "data": {
    "reason": "record.not-found",
    "detail": "Signer not found"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "7ZMqyx5Lk3PQwNrJvGIs9eT6ahcUKXZ8SbRj4WyF2dQ=",
        "digest": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
        "result": "VFp8RxnT2h+JK9W5/nJfLZdV1uLKXHBL5RwpnbZ4qDz3J1Ks4eOj7y9QVMhmwlIa5AQlNbdT3GJcvH8xo3WhBA=="
      }
    ]
  }
}

{
  "hash": "3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4c7b0a3f6e",
  "data": {
    "reason": "record.schema-invalid",
    "detail": "Schema validator error: data.handle must match pattern \"^[a-zA-Z0-9_\\\\-+.]+$\"",
    "custom": {
      "errors": [
        {
          "instancePath": "/handle",
          "schemaPath": "#/properties/handle/pattern",
          "keyword": "pattern",
          "params": {
            "pattern": "^[a-zA-Z0-9_\\\\-+.]+$"
          },
          "message": "must match pattern \"^[a-zA-Z0-9_\\\\-+.]+$\""
        }
      ]
    }
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "vL8jKxm5PqTnJfEaRs2uOdY7gzX4CS9WbHlN3cAiBV0=",
        "digest": "3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4c7b0a3f6e",
        "result": "uYxJLd2QGkEfT8rP7mCn1lHVzBvIaSK4jFqpO5ZwW9oADnMbg6yeiUsvN3tcXj0RwYxkrq5aLm9f4y2Ko8WwDw=="
      }
    ]
  }
}

{
  "hash": "e1d4c7b0a3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4",
  "data": {
    "reason": "api.unexpected-error",
    "detail": "An unexpected error occurred"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "KxiLpB3v8VEdmYsT2RwNq5o1Cz9gHJfU4aAySt7D0X8=",
        "digest": "e1d4c7b0a3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4",
        "result": "LzRmNh7x5TQYoqjw30BKDaZnbGcFUsX8v4tpEsr9P6iW1dyJkVC2uALfY8HdpM3eX9w0On12cqYxEtveKoFZDQ=="
      }
    ]
  }
}