Skip to main content

Get a Bank Counterparty

One US withdrawal destination, by id. A counterparty saved through v2 can be read too, by its id in TypeID form. The response carries the full account number.

A workspace-scoped key reads any US counterparty of the workspace. An account-scoped key reads only its own account's, and another account's reads as 404.

An id that is not a US counterparty — a deposit account, a pull account, another country's beneficiary, or a deleted counterparty — is the same 404. Those are one answer on purpose.

Replaces GET /api/v2/banking/counterparties/{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/banking/counterparties/{counterparty_id}

Path parameters​

ParameterTypeDescription
counterparty_idstring (bcp_…)Required. The counterparty.

Query parameters​

ParameterTypeDescription
includestringcustomer adds the holder's customer object.

Response Sample​

{
  "id": "bcp_01k8z5q7r9s1t3v5w7x9y1z3a5",
  "customer_id": "cst_01h455vb4pex5vsknk084sn02q",
  "reference": "vendor-42",
  "coin": "USD",
  "name": "Northwind LLC",
  "holder_type": "business",
  "bank_name": "Chase",
  "instrument": "ach",
  "account_type": "checking",
  "routing_number": "021000021",
  "account_number": "000123456789",
  "status": "active",
  "address": {
    "line1": "1 Market Street",
    "line2": "Suite 400",
    "city": "San Francisco",
    "state": "CA",
    "postal_code": "94105",
    "country": "US"
  },
  "created_at": "2026-10-23T12:00:00Z",
  "updated_at": "2026-10-23T12:00:00Z"
}

Response Schema​

The counterparty, with the fields of a List Bank Counterparties row. customer is present only with include=customer. bank_address is present only when one was saved.

Errors​

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

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!