Skip to main content

Get a Counterparty

One saved withdrawal destination, by id. A beneficiary saved through v2 can be read too, by its id in TypeID form.

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 reads any counterparty of the workspace; an account-scoped key reads only its own account's, and another account's reads as 404.

Replaces GET /api/v2/crypto/beneficiaries/{id}.

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/counterparties/{counterparty_id}

Path parameters​

ParameterTypeDescription
counterparty_idstring (wlt_…)Required. The counterparty.

Query parameters​

ParameterTypeDescription
includestringcustomer adds the holder's customer object.

Response Sample​

{
"id": "wlt_01k8z5q7r9s1t3v5w7x9y1z3a5",
"customer_id": "cst_01h455vb4pex5vsknk084sn02q",
"coin": "USDC",
"address": "0x8f3b2c1d0e9a7b6c5d4e3f2a1b0c9d8e7f6a5b4c",
"label": "Supplier payouts",
"network": "ERC20",
"reference": "supplier-17",
"status": "active",
"created_at": "2026-10-20T15:40:00Z",
"updated_at": "2026-10-20T15:40:00Z"
}

Response Schema​

The counterparty, with the fields of a List Counterparties row.

Errors​

StatusmessageWhen
400failed to parse requestcounterparty_id is not a wlt_… id, or include is not customer.
401unauthorizedMissing or invalid signature.
404counterparty_not_foundNo such counterparty, it belongs to another account, it was deleted, or the id is a deposit wallet's.

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!