Skip to main content

Balances of One Bank Account

What one bank account holds. The same rows as List Balances, for one bank account.

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/bank-accounts/{bank_account_id}/balances

Path parameters​

ParameterTypeDescription
bank_account_idstring (bnk_…)Required. The bank account.

An account-scoped key reads only its own account's bank accounts; another account's reads as 404. A workspace-scoped key reads any bank account of the workspace.

Response Sample​

{
  "data": [
    {
      "coin": "USD",
      "bank_account_id": "bnk_01k8x4m2qv7r3t5w9y1a3c5e7g",
      "bank_account_name": "Operating",
      "bank_account_is_default": true,
      "available": { "amount": "1250.75", "currency": "USD" },
      "pending_credits": { "amount": "500.00", "currency": "USD" },
      "pending_debits": { "amount": "100.25", "currency": "USD" },
      "reserved": { "amount": "0", "currency": "USD" }
    }
  ],
  "totals": [
    {
      "coin": "USD",
      "available": { "amount": "1250.75", "currency": "USD" },
      "pending_credits": { "amount": "500.00", "currency": "USD" },
      "pending_debits": { "amount": "100.25", "currency": "USD" },
      "reserved": { "amount": "0", "currency": "USD" }
    }
  ]
}

Response Schema​

Same as List Balances.

Errors​

StatusmessageWhen
401unauthorizedMissing or invalid signature.
403forbiddenNot allowed for this caller. Every API key is allowed.
404bank_account_not_foundNo such bank account, or it belongs to 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!