Skip to main content
16/03/2026

​
Granular OAuth Scopes and Credential Rotation

OAuth credentials now support granular scopes and scope bundles, giving integrators fine-grained control over API access.

  • Added documentation for 21 individual OAuth scopes (e.g. wallet:read, payout:create, webhook:write) and 6 scope bundles (e.g. full-access, read-only, payouts).
  • Added credential rotation guide — rotate credentials from the dashboard to change scopes or recover from a compromised secret.
  • Webhook registration endpoint now returns a signing_secret in the response. Store this securely to verify x-blaaiz-signature headers.
  • Legacy API key creation is now disabled. Legacy API key authentication will be removed soon.
15/03/2026

​
OAuth Authentication and Webhook Signing Secret

Blaaiz Platform API authentication is now documented around OAuth client credentials for integrations.

  • Added OAuth token acquisition guidance for API access.
  • Updated guides and API reference examples to use Bearer tokens instead of legacy API key headers.
  • Clarified that webhook signature verification uses a dedicated webhook signing_secret, not an API credential secret.
  • Marked legacy API key usage as temporary and advised all integrators to switch fully to OAuth immediately.
15/03/2026

​
Common Use Cases Guide

We added a new Common use cases guide that walks through the most popular patterns businesses build with the Blaaiz Platform API.

  • Cross-border remittances — collect in one currency, pay out in another.
  • Marketplace and platform payouts — disburse to sellers across countries.
  • Payroll for distributed teams — pay employees in their local currency.
  • Virtual accounts for deposit collection — issue dedicated accounts per customer.
  • Crypto on/off-ramps — accept stablecoins and settle to fiat.
  • B2B invoice and vendor payments — automate cross-border vendor payments.

Each use case includes a flow diagram, step-by-step integration guide, and links to the relevant API endpoints.

13/03/2026

​
Merchant Redirect URL for Collections

The Initiate Collection endpoint now accepts an optional redirect_url parameter. After payment authorization (e.g. 3DS for card collections or open banking), the customer is automatically redirected to your specified URL with transaction_id and status query parameters appended.

  • Only HTTPS URLs are accepted (max 2048 characters).
  • If no redirect_url is provided, the existing default redirect behavior is used.
  • Query parameters are appended with the correct separator whether your URL already contains a query string or not.
13/03/2026

​
Swap API Reference and Transaction Response Updates

We added documentation for the new POST /api/external/swap endpoint so businesses can swap funds between their own wallets.

We also updated the transaction reference to document the latest response shape returned by the API.

Other updates:

  • Added the new Swap API reference section and navigation entry.
  • Documented type: SWAP as a supported filter on the transaction list endpoint.
  • Added swap_details to both the list and show transaction response examples and schemas.
  • Added swap-specific error examples, including validation and access restriction responses.
03/03/2026

​
Virtual Bank Accounts Guide & Payout Documentation Improvements

We added a new Virtual Bank Accounts guide that explains what Virtual Bank Accounts are, how to create them, and the prerequisites for each supported currency (NGN, GBP, EUR, USD).

We also expanded the Creating your first payout guide with currency-specific prerequisites and common error scenarios for NGN, GBP, USD, EUR, and CAD payouts.

Other updates:

  • Updated the Virtual Bank Account creation response message to reflect the new “initiated” status wording.
  • Added new Virtual Bank Account validation error examples to the Payout API reference.
  • Added request examples for every supported currency and payout method (NGN, GBP, USD ACH, USD Wire, EUR, CAD Interac, and Crypto) to the Payout API reference.
09/01/2026

​
Added Virtual Account Closure Endpoint

We added a new endpoint that allows you to close a virtual account. This could be useful for when a user no longer needs a virtual account or when a virtual account is no longer needed.

Checkout thedocsfor more information.

25/12/2025

​
New Blaaiz Platform API Documentation 🎉

Migrated to the new docs platform. It now features: a more intuitive navigation and a better search experience.

  • A more intuitive navigation and a better search experience.
  • An interactive playground for testing API endpoints.
  • Refined API Reference layout and examples.