List Deposit Wallets

The deposit wallets of the workspace or of one account, newest first. Wallets created through v2 are listed too. Counterparties are not: they have their own list.

Beta

Part of crypto v3, in beta. This endpoint is open whether or not crypto v3 is enabled for the workspace.

A workspace-scoped key lists every wallet in the workspace, or one account's with customer_id; an account-scoped key lists its own account's wallets.

Replaces GET /api/v2/crypto/wallets.

Authorization:

Every request is signed with your API key: a short-lived JWT, signed with your private key, sent in one header on /v3/* and /api/v2/* alike.

Headers:
  Authorization: APIKey {SIGNED_JWT}

How to build and sign the JWT: Authentication.

Endpoint

GET

/v3/crypto/wallets

Query parameters

Parameter	Type	Description
customer_id	string (cst_…)	Only this account's wallets. An account-scoped key may omit it; naming another account is refused.
coin	string	Only wallets in this coin, for example BTC. Any casing.
status	string	Only wallets in this status: active, inactive, pending or issue.
q	string	At least 3 characters. Matched, ignoring case, against the wallet's address and label and the holder's name, email and reference. A wallet id (wlt_…) or an account id (cst_…) finds exactly that wallet, or that account's wallets.
created_at_gte	string (date-time)	Created at or after this time. RFC 3339, or a date (2026-10-01) for midnight UTC at its start.
created_at_lt	string (date-time)	Created before this time, in the same forms.
include	string	customer adds the holder's customer object to each row. Wallets whose account was deleted are then left out of data and total_items.
page	integer	Page number, from 1. Default 1.
limit	integer	Rows per page. Default 25, at most 100.

Response Sample

{
  "data": [
    {
      "id": "wlt_01k8y2c7d3e5f7g9h1j3k5m7n9",
      "customer_id": "cst_01h455vb4pex5vsknk084sn02q",
      "coin": "BTC",
      "address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
      "label": "Savings",
      "status": "active",
      "customer": {
        "id": "cst_01h455vb4pex5vsknk084sn02q",
        "name": "Ava Kim",
        "email": "ava.kim@example.com"
      },
      "created_at": "2026-10-20T14:10:42Z",
      "updated_at": "2026-10-20T14:10:42Z"
    }
  ],
  "page": 1,
  "limit": 25,
  "total_items": 1,
  "total_pages": 1
}

This sample was requested with include=customer.

Response Schema

Field	Type	Description
data	array	The wallets on this page.
data[].id	string (wlt_…)	The wallet. v2's wallet id, as a TypeID.
data[].customer_id	string (cst_…)	The account that holds it.
data[].coin	string	The coin it receives, upper case.
data[].address	string	Where to send that coin. On XRP, which routes by memo, the memo is part of it: <address>?dt=<tag>; give the sender both.
data[].label	string	Your name for the wallet. Absent when it has none.
data[].status	string	active, inactive, pending or issue. A wallet opened through v3 starts active.
data[].customer	object	The holder: id (cst_…), name, email. Only with include=customer.
data[].created_at / updated_at	string (date-time)	RFC 3339, UTC.
page, limit, total_items, total_pages	integer	Pagination, as described in the API v3 overview. next_cursor and prev_cursor are not returned yet.

Errors

Status	message	When
400	failed to parse request	A parameter has the wrong form: page or limit is not an integer, status is not one of the listed values, customer_id is not a cst_… id, a date is neither RFC 3339 nor YYYY-MM-DD, or include is not customer.
401	unauthorized	Missing or invalid signature.
403	forbidden	An account-scoped key named another account.
422	Validation failed	q is shorter than 3 characters; details names it.

Coming from v2

v2 (GET /api/v2/crypto/wallets)	v3
accountId	customer_id
only wallets at the custodian each coin uses now, by coin, then newest	every deposit wallet, newest first
page, limit (default 100)	page, limit (default 25, at most 100)
—	q, created_at_gte, created_at_lt, include=customer
total	total_items, total_pages
id, accountId (uuid)	id (wlt_…), customer_id (cst_…)
createdAt, updatedAt	created_at, updated_at

Support and Resources

If you need assistance or have any questions, our support team is here to help. You can contact our support team at support@blockwyre.com.

Stay Updated

Stay up-to-date with the latest news, updates, and features from BlockWyre by following us on social media:

• Instagram: BlockWyre Instagram
• Twitter: BlockWyre Twitter
• Facebook: BlockWyre Facebook
• LinkedIn: BlockWyre LinkedIn

We are excited to have you on board and look forward to seeing how you leverage BlockWyre's powerful tools to enhance your financial operations. Happy integrating!