# Blaaiz

## Docs

- [Get OAuth access token](https://docs.business.blaaiz.com/api-reference/authentication/get-oauth-access-token.md): Exchange your OAuth client credentials for a short-lived access token. Submit this request as application/x-www-form-urlencoded. Use the returned Bearer token on subsequent calls to /api/external/* endpoints. Client credentials tokens do not return refresh tokens.
- [List all banks](https://docs.business.blaaiz.com/api-reference/bank/list-all-banks.md): Retrieve all supported banks. Filter by currency or country if desired. Required scope: `bank:read`.
- [Resolve bank account](https://docs.business.blaaiz.com/api-reference/bank/resolve-bank-account.md): Verify the validity of a bank account by providing account number and bank_id. Required scope: `bank:read`.
- [Accept Interac money request](https://docs.business.blaaiz.com/api-reference/collection/accept-interac-money-request.md): Accept an Interac transfer into your business wallet. Required scope: `collection:interac:accept`.
- [Attach customer to collection](https://docs.business.blaaiz.com/api-reference/collection/attach-customer-to-collection.md): Associate a collection transaction with a verified customer.
- [Get crypto networks](https://docs.business.blaaiz.com/api-reference/collection/get-crypto-networks.md): Retrieve all available blockchain networks and their supported tokens. Required scope: `collection:crypto:create`.
- [Initiate a collection](https://docs.business.blaaiz.com/api-reference/collection/initiate-a-collection.md): Create a card collection request for a business wallet. Card collections require a verified customer and card details, and may not be enabled for every business. Customer attachment after creation is not supported for API card collections. Required scope: `collection:create`.
- [Initiate crypto collection](https://docs.business.blaaiz.com/api-reference/collection/initiate-crypto-collection.md): Initiate a crypto collection to fund a wallet using cryptocurrency. Required scope: `collection:crypto:create`.
- [List all currencies](https://docs.business.blaaiz.com/api-reference/currency/list-all-currencies.md): Retrieve all supported currencies. Required scope: `currency:read`.
- [Add KYC details](https://docs.business.blaaiz.com/api-reference/customer/add-kyc-details.md): Add KYC details for a customer. Verification stays PENDING until documents are uploaded and reviewed. The customer's country must match the country on the identity document submitted for KYC. Accepted identity documents: Driver's License, Passport, or Resident Permit for individual customers, Certif…
- [Create a customer](https://docs.business.blaaiz.com/api-reference/customer/create-a-customer.md): Create a new customer. Verification remains PENDING until KYC files are uploaded and reviewed. The customer's country must match the country on the identity document submitted for KYC. Accepted identity documents: Driver's License, Passport, or Resident Permit for individual customers, Certificate o…
- [Get a customer](https://docs.business.blaaiz.com/api-reference/customer/get-a-customer.md): Retrieve customer details by ID. Required scope: `customer:read`.
- [Get beneficiary](https://docs.business.blaaiz.com/api-reference/customer/get-beneficiary.md): Retrieve details of a specific beneficiary for a customer. Required scope: `beneficiary:read`.
- [List all customers](https://docs.business.blaaiz.com/api-reference/customer/list-all-customers.md): Retrieve all customers with optional filters and pagination. Required scope: `customer:read`.
- [List beneficiaries](https://docs.business.blaaiz.com/api-reference/customer/list-beneficiaries.md): Retrieve all beneficiaries for a customer. Required scope: `beneficiary:read`.
- [Update a customer](https://docs.business.blaaiz.com/api-reference/customer/update-a-customer.md): Update customer profile details. Non-verified customers can update all fields. Verified customers can only update fields that are currently null — if you need to correct a mistake on a verified customer (wrong document, misspelled name, incorrect details), you must request a manual correction from t…
- [Upload files for a customer](https://docs.business.blaaiz.com/api-reference/customer/upload-files-for-a-customer.md): Upload verification files for a customer. Use file_id values from the File API presigned upload. Newly uploaded files override previous records. The id_file must be uploaded for verification. The identity document must be a Driver's License, Passport, or Resident Permit for individual customers, or…
- [Get fees breakdown](https://docs.business.blaaiz.com/api-reference/fees/get-fees-breakdown.md): Calculate fees for a transaction between two currencies. Provide either from_amount or to_amount (not both). Required scope: `fees:read`.
- [Request file upload URL](https://docs.business.blaaiz.com/api-reference/file/request-file-upload-url.md): Request a pre-signed URL to upload a file for a customer.
- [Overview](https://docs.business.blaaiz.com/api-reference/overview.md): Complete API reference for the Blaaiz Platform API
- [Create a payout](https://docs.business.blaaiz.com/api-reference/payout/create-a-payout.md): This endpoint is used to initiate a payout from a business wallet to a recipient using the specified payout method.     We advise to call the `fees breakdown` endpoint to get up-to-date fees before proceeding with transaction.     For payouts in all currencies, we deliver a webhook when the payment…
- [List rates](https://docs.business.blaaiz.com/api-reference/rate/list-rates.md): Retrieve exchange rates applicable to the authenticated business.
- [Retrieve all virtual bank accounts](https://docs.business.blaaiz.com/api-reference/retrieve-all-virtual-bank-accounts.md): Fetches all virtual bank accounts (VBAs) for the specified wallet. Required scope: `virtual-account:read`.
- [Swap money between business wallets](https://docs.business.blaaiz.com/api-reference/swap/swap-money-between-business-wallets.md): Swap money between two wallets owned by your business. The wallets must exist, belong to the same business, and use different currencies. This endpoint is available only when your business is allowed to perform API-services swaps. Required scope: `swap:create`.
- [Get transaction](https://docs.business.blaaiz.com/api-reference/transaction/get-transaction.md): Retrieve a completed API transaction by its transaction ID or reference. Required scope: `transaction:read`.
- [List transactions](https://docs.business.blaaiz.com/api-reference/transaction/list-transactions.md): Retrieve a paginated list of completed API transactions for your business. You can filter by date range, status, customer, wallet, and transaction type. Use `type: SWAP` to return only swap transactions. Required scope: `transaction:read`.
- [Close a virtual bank account](https://docs.business.blaaiz.com/api-reference/virtual-bank-accounts/close-a-virtual-bank-account.md): Initiate closure of a virtual bank account. Supported currencies: GBP, EUR, NGN, USD. Returns 400 if already closed or provider/currency not supported; 404 if not found. Required scope: `virtual-account:close`.
- [Create virtual bank account](https://docs.business.blaaiz.com/api-reference/virtual-bank-accounts/create-virtual-bank-account.md): Generates a new virtual bank account for the specified wallet. Supports NGN, GBP, USD, EUR.
- [Get identification type](https://docs.business.blaaiz.com/api-reference/virtual-bank-accounts/get-identification-type.md): Look up the country-specific identification type that a customer must provide as their `tin` value. Each country uses a different identification system (e.g. SSN in the US, BVN in Nigeria, NINO in the UK), and individual vs business customers within the same country may require different types. Call…
- [Retrieve a single virtual bank account](https://docs.business.blaaiz.com/api-reference/virtual-bank-accounts/retrieve-a-single-virtual-bank-account.md): Retrieves details of a specific virtual bank account by its ID. Required scope: `virtual-account:read`.
- [Get wallet](https://docs.business.blaaiz.com/api-reference/wallet/get-wallet.md): Retrieve a single wallet by ID. Required scope: `wallet:read`.
- [List all wallets](https://docs.business.blaaiz.com/api-reference/wallet/list-all-wallets.md): Retrieve all business wallets. Required scope: `wallet:read`.
- [Get webhook URLs](https://docs.business.blaaiz.com/api-reference/webhook/get-webhook-urls.md): Retrieve your registered webhook URLs. Your collection_url is used for collection events, virtual account events, and customer KYC events. Required scope: `webhook:read`.
- [Register webhook URLs](https://docs.business.blaaiz.com/api-reference/webhook/register-webhook-urls.md): Register webhook URLs to receive event notifications. URLs must be HTTPS; Blaaiz signs requests via x-blaaiz-signature. Verify deliveries with your webhook signing_secret. Your collection_url receives collection events, virtual account events, and customer KYC events such as customer.created, custom…
- [Replay webhook](https://docs.business.blaaiz.com/api-reference/webhook/replay-webhook.md): Trigger a webhook on demand for a successful transaction. Required scope: `webhook:replay`.
- [Simulate Interac webhook (non-production)](https://docs.business.blaaiz.com/api-reference/webhook/simulate-interac-webhook-non-production.md): Sends a mock Interac collection webhook to your configured collection_url. Only available outside production; returns 400 in production. Required scope: `mock:webhook:trigger`.
- [Update webhook URL](https://docs.business.blaaiz.com/api-reference/webhook/update-webhook-url.md): Update your registered webhook URLs. Your collection_url receives collection events, virtual account events, and customer KYC events. Required scope: `webhook:write`.
- [Updates & improvements](https://docs.business.blaaiz.com/changelog.md): Release notes for Blaaiz docs and API. Follow along for new endpoints, UI polish, and integration guides.
- [API integration](https://docs.business.blaaiz.com/faq/api-integration.md): Common questions about integrating with the Blaaiz API
- [Collection methods by currency](https://docs.business.blaaiz.com/faq/collection-methods.md): Learn how to collect payments in different currencies
- [Fees and processing](https://docs.business.blaaiz.com/faq/fees-and-processing.md): Understanding transaction fees and processing
- [Payment links and redirections](https://docs.business.blaaiz.com/faq/payment-links.md): Understanding when and how to use payment links
- [Virtual bank accounts](https://docs.business.blaaiz.com/faq/virtual-bank-accounts.md): Frequently asked questions about virtual bank accounts
- [Wallet & collection basics](https://docs.business.blaaiz.com/faq/wallet-collection-basics.md): Common questions about wallets and collections
- [Webhooks and notifications](https://docs.business.blaaiz.com/faq/webhooks-and-notifications.md): Learn about webhook notifications for transactions
- [API parameters](https://docs.business.blaaiz.com/guides/api-parameters.md): Common parameters used across Blaaiz API endpoints
- [Authentication](https://docs.business.blaaiz.com/guides/authentication.md): Learn how to authenticate your API requests to the Blaaiz API.
- [Collections overview](https://docs.business.blaaiz.com/guides/collections-overview.md): Understanding collections and how to attach customers to transactions
- [Common use cases](https://docs.business.blaaiz.com/guides/common-use-cases.md): Real-world scenarios showing how businesses use the Blaaiz Platform API
- [Creating your first payout](https://docs.business.blaaiz.com/guides/creating-first-payout.md): Step-by-step guide to creating your first payout
- [Customer data corrections](https://docs.business.blaaiz.com/guides/customer-data-corrections.md): How to request changes to verified customer records that can no longer be updated via the API
- [General Guidelines](https://docs.business.blaaiz.com/guides/general-guidelines.md): Guidelines for using the Blaaiz Platform API
- [Getting Started](https://docs.business.blaaiz.com/guides/getting-started.md): Learn how to get started with the Blaaiz Platform API Services
- [Interac Auto Deposits](https://docs.business.blaaiz.com/guides/interac-auto-deposits.md): Learn how Interac Auto Deposits work on Blaaiz and how to receive CAD collections seamlessly.
- [IP whitelisting](https://docs.business.blaaiz.com/guides/ip-whitelisting.md): Learn how to whitelist your IP addresses for API access
- [Money movement](https://docs.business.blaaiz.com/guides/money-movement.md): How funds flow through Blaaiz for collections, payouts, and wallets
- [Rate and usage limits](https://docs.business.blaaiz.com/guides/rate-limits.md): Understand API rate limits and usage restrictions
- [SDKs](https://docs.business.blaaiz.com/guides/sdks.md): Supercharge your integration with Blaaiz SDKs
- [B2B invoice and vendor payments](https://docs.business.blaaiz.com/guides/use-cases/b2b-vendor-payments.md): Automate cross-border vendor payments via optimal local rails
- [Cross-border remittances](https://docs.business.blaaiz.com/guides/use-cases/cross-border-remittances.md): Build a remittance product that collects in one currency and pays out in another
- [Crypto on/off-ramps](https://docs.business.blaaiz.com/guides/use-cases/crypto-on-off-ramps.md): Accept stablecoin deposits and convert between crypto and fiat
- [🇨🇦 Interac CAD collections](https://docs.business.blaaiz.com/guides/use-cases/interac-collections.md): Collect CAD from customers via Interac Auto Deposit and identify senders using webhook emails
- [Multi-currency wallets and liquidity management](https://docs.business.blaaiz.com/guides/use-cases/liquidity-management.md): Mirror user swaps on Blaaiz to keep wallet liquidity balanced across currencies
- [Marketplace and platform payouts](https://docs.business.blaaiz.com/guides/use-cases/marketplace-payouts.md): Collect from buyers and disburse to sellers across multiple countries
- [Payroll for distributed teams](https://docs.business.blaaiz.com/guides/use-cases/payroll.md): Pay employees and contractors in their local currency from a single wallet
- [Virtual accounts for deposit collection](https://docs.business.blaaiz.com/guides/use-cases/virtual-accounts-deposit-collection.md): Issue dedicated bank accounts to customers for automatic deposit reconciliation
- [Virtual Bank Accounts](https://docs.business.blaaiz.com/guides/virtual-bank-accounts.md): How to create and manage Virtual Bank Accounts for receiving payments
- [CAD](https://docs.business.blaaiz.com/guides/webhooks/collection/cad.md): Webhook payload for CAD collection transactions
- [EUR](https://docs.business.blaaiz.com/guides/webhooks/collection/eur.md): Webhook payload for EUR collection transactions
- [GBP](https://docs.business.blaaiz.com/guides/webhooks/collection/gbp.md): Webhook payload for GBP collection transactions
- [NGN](https://docs.business.blaaiz.com/guides/webhooks/collection/ngn.md): Webhook payload for NGN collection transactions
- [USD](https://docs.business.blaaiz.com/guides/webhooks/collection/usd.md): Webhook payload for USD collection transactions
- [Customer](https://docs.business.blaaiz.com/guides/webhooks/customer.md): Webhook payloads for customer verification events
- [Webhook events and payloads](https://docs.business.blaaiz.com/guides/webhooks/events.md): Reference for Blaaiz webhook event types and common payload structure
- [CAD](https://docs.business.blaaiz.com/guides/webhooks/payout/cad.md): Webhook payload for CAD payout transactions
- [EUR](https://docs.business.blaaiz.com/guides/webhooks/payout/eur.md): Webhook payload for EUR payout transactions
- [GBP](https://docs.business.blaaiz.com/guides/webhooks/payout/gbp.md): Webhook payload for GBP payout transactions
- [NGN](https://docs.business.blaaiz.com/guides/webhooks/payout/ngn.md): Webhook payload for NGN payout transactions
- [USD](https://docs.business.blaaiz.com/guides/webhooks/payout/usd.md): Webhook payload for USD payout transactions
- [JavaScript](https://docs.business.blaaiz.com/guides/webhooks/signature-verification/javascript.md): Verify webhook signatures using JavaScript
- [Code examples for signature verification](https://docs.business.blaaiz.com/guides/webhooks/signature-verification/overview.md): Verify webhook signatures to ensure payload integrity and authenticity
- [PHP](https://docs.business.blaaiz.com/guides/webhooks/signature-verification/php.md): Verify webhook signatures using PHP
- [Virtual account](https://docs.business.blaaiz.com/guides/webhooks/virtual-account.md): Webhook payloads for virtual account events
- [Home](https://docs.business.blaaiz.com/home.md): Global Payment APIs - Connect to Swift, SEPA, ACH & More in Days

## OpenAPI Specs

- [create-openapi](https://docs.business.blaaiz.com/api-reference/file/create-openapi.json)
- [upload-files-openapi](https://docs.business.blaaiz.com/api-reference/customer/upload-files-openapi.json)
- [update-openapi](https://docs.business.blaaiz.com/api-reference/customer/update-openapi.json)
- [add-kyc-openapi](https://docs.business.blaaiz.com/api-reference/customer/add-kyc-openapi.json)
- [list-beneficiaries-openapi](https://docs.business.blaaiz.com/api-reference/customer/list-beneficiaries-openapi.json)
- [get-beneficiary-openapi](https://docs.business.blaaiz.com/api-reference/customer/get-beneficiary-openapi.json)
- [list-openapi](https://docs.business.blaaiz.com/api-reference/rate/list-openapi.json)
- [replay-openapi](https://docs.business.blaaiz.com/api-reference/webhook/replay-openapi.json)
- [register-openapi](https://docs.business.blaaiz.com/api-reference/webhook/register-openapi.json)
- [get-openapi](https://docs.business.blaaiz.com/api-reference/webhook/get-openapi.json)
- [get-identification-type-openapi](https://docs.business.blaaiz.com/api-reference/virtual-bank-account/get-identification-type-openapi.json)
- [close-openapi](https://docs.business.blaaiz.com/api-reference/virtual-bank-account/close-openapi.json)
- [simulate-webhook-interac-openapi](https://docs.business.blaaiz.com/api-reference/mock/simulate-webhook-interac-openapi.json)
- [get-breakdown-openapi](https://docs.business.blaaiz.com/api-reference/fees/get-breakdown-openapi.json)
- [initiate-crypto-openapi](https://docs.business.blaaiz.com/api-reference/collection/initiate-crypto-openapi.json)
- [get-crypto-networks-openapi](https://docs.business.blaaiz.com/api-reference/collection/get-crypto-networks-openapi.json)
- [attach-customer-openapi](https://docs.business.blaaiz.com/api-reference/collection/attach-customer-openapi.json)
- [accept-interac-openapi](https://docs.business.blaaiz.com/api-reference/collection/accept-interac-openapi.json)
- [account-lookup-openapi](https://docs.business.blaaiz.com/api-reference/bank/account-lookup-openapi.json)
- [token-openapi](https://docs.business.blaaiz.com/api-reference/auth/token-openapi.json)

## Optional

- [Dashboard](https://business.blaaiz.com)
- [Support](mailto:support@blaaiz.com)