Skip to main content

List Crypto Withdrawals

The crypto withdrawals of the workspace or of one account, newest first. Withdrawals created through v2 are listed too: they are the same records.

Beta

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

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

New in v3: v2 lists crypto withdrawals only among all transactions, in List Transactions.

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/withdrawals

Query parameters​

ParameterTypeDescription
account_idstring (cst_…)Only this account's withdrawals. An account-scoped key may omit it; naming another account is refused.
counterparty_idstring (wlt_…)Only the withdrawals sent to this counterparty.
coinstringOnly withdrawals of this coin, for example USDC. Any casing.
statusstringOnly withdrawals in this status: see The life of a withdrawal.
created_at_gtestring (date-time)Created at or after this time. RFC 3339, or a date (2026-10-01) for midnight UTC at its start.
created_at_ltstring (date-time)Created before this time, in the same forms.
pageintegerPage number, from 1. Default 1.
limitintegerRows per page. Default 25, at most 100.

Response Sample​

{
  "data": [
    {
      "id": "wtx_01k9a1b3c5d7e9f1g3h5j7k9m1",
      "account_id": "cst_01h455vb4pex5vsknk084sn02q",
      "status": "success",
      "coin": "USDC",
      "amount": "250",
      "fee": "10",
      "total": "240",
      "counterparty_id": "wlt_01k8z5q7r9s1t3v5w7x9y1z3a5",
      "counterparty_address": "0x8f3b2c1d0e9a7b6c5d4e3f2a1b0c9d8e7f6a5b4c",
      "reference": "inv-2026-10-0042",
      "status_reason": "Completed by the custody provider",
      "provider": "fireblocks",
      "external_id": "7f3c1a2e-9b4d-4e8a-a1c2-5d6e7f8a9b0c",
      "tx_hash": "0x9f1c2b3a4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f708192a3b4c5d6e7f8",
      "grace_ends_at": "2026-10-20T18:05:00Z",
      "created_at": "2026-10-20T18:00:00Z",
      "updated_at": "2026-10-20T18:11:37Z"
    },
    {
      "id": "wtx_01k7w2c4e6g8j0m2p4r6t8v0x2",
      "account_id": "cst_01h455vb4pex5vsknk084sn02q",
      "status": "success",
      "coin": "USDT",
      "amount": "1000",
      "fee": "25",
      "total": "975",
      "counterparty_id": "wlt_01k6v1b3d5f7h9k1n3q5s7u9w1",
      "counterparty_address": "TQn9Y2khEsLJW1ChVWFMSMeRDow5KcbLSE",
      "reference": "",
      "provider": "fireblocks",
      "external_id": "c2d4e6f8-0a1b-4c3d-8e5f-7a9b1c3d5e7f",
      "tx_hash": "4b6d8f0a2c4e6a8c0e2a4c6e8a0c2e4a6c8e0a2c4e6a8c0e2a4c6e8a0c2e4a6c",
      "created_at": "2026-10-02T14:21:09Z",
      "updated_at": "2026-10-02T14:33:52Z"
    }
  ],
  "page": 1,
  "limit": 25,
  "total_items": 2,
  "total_pages": 1
}

The second withdrawal was created through v2: it has no grace_ends_at and an empty reference.

Response Schema​

FieldTypeDescription
dataarrayThe withdrawals on this page, each with the fields described in Create a Crypto Withdrawal.
page, limit, total_items, total_pagesintegerPagination, as described in the API v3 overview. next_cursor and prev_cursor are not returned yet.

A withdrawal created through v2 differs in two fields: grace_ends_at is absent and reference is empty, because v2 writes neither. On an old one whose counterparty record was removed, counterparty_id is absent too; counterparty_address still says where the money went. It is cancelled through v2's Cancel Crypto Withdraw, not through Cancel a Crypto Withdrawal.

Errors​

StatusmessageWhen
400failed to parse requestA parameter has the wrong form: page or limit is not an integer, coin is not a ticker, status is not one of the listed values, account_id is not a cst_… id, counterparty_id is not a wlt_… id, or a date is neither RFC 3339 nor YYYY-MM-DD.
401unauthorizedMissing or invalid signature.
403forbiddenAn account-scoped key named another account.

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:

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!