Bank Account Stats

Summary figures: how many bank accounts and counterparties there are, how many accounts hold a bank account, and what is held per coin.

The scope comes from the key and cannot be chosen. The endpoint takes no parameters.

• A workspace-scoped key gets the figures for the whole workspace, across every account. It cannot narrow them to one account.
• An account-scoped key gets its own account's figures. customers_with_bank_accounts is then 1, or 0 if the account holds no bank account.

New in v3: v2 has no equivalent.

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

Response Sample

{
  "total_bank_accounts": 12,
  "customers_with_bank_accounts": 8,
  "counterparties": 5,
  "totals": [
    {
      "coin": "BTC",
      "available": { "amount": "0.254321", "currency": "BTC" },
      "pending_credits": { "amount": "0", "currency": "BTC" },
      "pending_debits": { "amount": "0.01", "currency": "BTC" },
      "reserved": { "amount": "0", "currency": "BTC" }
    },
    {
      "coin": "USD",
      "available": { "amount": "48210.40", "currency": "USD" },
      "pending_credits": { "amount": "1500.00", "currency": "USD" },
      "pending_debits": { "amount": "320.25", "currency": "USD" },
      "reserved": { "amount": "25.00", "currency": "USD" }
    }
  ]
}

Response Schema

Field	Type	Description
total_bank_accounts	integer	Bank accounts in scope, whatever their status.
customers_with_bank_accounts	integer	Accounts holding at least one bank account.
counterparties	integer	Saved external bank accounts (counterparties) in scope.
totals	array	Per coin, everything held in scope, crypto included, summed from the balances. Computed, never stored.
totals[].coin	string	Coin.
totals[].available / pending_credits / pending_debits / reserved	money	As in List Balances.

A money value is { "amount": "<decimal string>", "currency": "<coin>" }.

Errors

Status	message	When
401	unauthorized	Missing or invalid signature.

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!