Skip to main content

Overview

BlockWyre's API lets a workspace automate what it does for its customer accounts: onboarding and verifying them, holding their balances, moving fiat and crypto, and trading between the two.

Key Features​

The BlockWyre API provides:

  • Customer onboarding: create customer accounts and verify them (KYC for individuals, KYB for businesses).
  • Balances and bank accounts: read balances per account and bank account, open bank accounts, get deposit instructions, and fund accounts by ACH pull.
  • Payments and withdrawals: send fiat to bank counterparties and crypto to external wallets.
  • Trading: preview and execute conversions between crypto and fiat.
  • Real-time data: webhooks when something changes, and a WebSocket feed of market prices.
  • Scoped access: a workspace-scoped API key acts for the whole workspace; an account-scoped key acts for one customer account only. Every key holds the same fixed permission set. See Key types and permissions.

Members, roles, API keys and workspace settings are managed in the BlockWyre dashboard, not through the API.

API versions​

The current version is v3, served under /v3. /api/v2 is still supported; a v2 endpoint that has a v3 replacement says so at the top of its page. See Versioning.

Where to start​

  1. Getting Started: the sandbox and production URLs.
  2. Sandbox Credentials: get access and create an API key.
  3. Authentication: sign every request with your Ed25519 key.

Target Audience​

The BlockWyre API is designed for:

  • Financial Institutions: banks, investment firms, and other financial service providers integrating BlockWyre's functionality into their systems.
  • Fintech Companies: startups and established companies building BlockWyre into their products and services.
  • Developers and Tech Teams: engineers building custom solutions for financial management and operations.

Benefits​

  • Streamlined Operations: automate onboarding, payments and conversions that would otherwise be manual.
  • Security by design: every request is signed with an Ed25519 key that never leaves your server, and each key is limited to what the API documents.
  • One integration for fiat and crypto: the same credentials, ids and conventions across banking, crypto and trading.

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!