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_urlis 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.
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
SwapAPI reference section and navigation entry. - Documented
type: SWAPas a supported filter on the transaction list endpoint. - Added
swap_detailsto both the list and show transaction response examples and schemas. - Added swap-specific error examples, including validation and access restriction responses.
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.
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.

