# WireBloom Banking Platform API

> One versioned REST API (`/v1`, OpenAPI 3.1.0) for balances, payments, recipients, exchanges and webhooks of a WireBloom customer account. Contract version 1.0.0-draft.14. Authenticate with a bearer API key and send `X-Tenant-Id`.

Production base URL: https://bank.wirebloom.com/v1. Sandbox base URL: https://bank.wirebloom.com/v1 (`wb_test_` keys).

## Guides

- [Getting started](https://developers.wirebloom.com/md/docs/getting-started.md): Environments, your first API key and your first request.
- [Authentication and API keys](https://developers.wirebloom.com/md/docs/authentication.md): Bearer API keys, scopes, IP allow-lists, expiry and rotation.
- [Tenancy](https://developers.wirebloom.com/md/docs/tenancy.md): The X-Tenant-Id header and how keys are bound to one customer.
- [Idempotency](https://developers.wirebloom.com/md/docs/idempotency.md): Safe retries with the Idempotency-Key header.
- [Pagination, sorting and filtering](https://developers.wirebloom.com/md/docs/pagination.md): Cursor pagination, sort and filter parameters on list operations.
- [Errors](https://developers.wirebloom.com/md/docs/errors.md): RFC 9457 problem details and how to handle them.
- [Rate limits](https://developers.wirebloom.com/md/docs/rate-limits.md): Per-key request buckets and the RateLimit headers.
- [Webhooks and signature verification](https://developers.wirebloom.com/md/docs/webhooks.md): Register endpoints, verify signatures, retries, pause and secret rotation.
- [Sandbox and simulation](https://developers.wirebloom.com/md/docs/sandbox.md): Deterministic sandbox bank rules and the simulation endpoints.
- [Versioning and deprecation](https://developers.wirebloom.com/md/docs/versioning.md): What changes without notice, what needs a new major version, and how deprecations are announced.
- [Migrating from the Integrated Finance API](https://developers.wirebloom.com/md/docs/migrating-from-integrated-finance.md): Resource and convention mapping for integrations built against Integrated Finance.
- [Integration and usage](https://developers.wirebloom.com/md/docs/integration-usage.md): Where operators and developers see API keys, per-key usage and webhook health.

## API reference

- [tenants](https://developers.wirebloom.com/md/reference/tenants.md): Operators, customers, people (memberships), invitations, teams and customer settings (currencies, addresses, alerts, approved domains, approval policies, primary owner, closure).
- [onboarding](https://developers.wirebloom.com/md/reference/onboarding.md): Customer KYB case: wizard data, persons (directors, UBOs), documents, submission, KYC provider SDK tokens, operator review queue and decisions (D-22).
- [accounts](https://developers.wirebloom.com/md/reference/accounts.md): Balances (ledger accounts per currency and sub-balances), account details per rail, journal with running balance, statements, currencies.
- [recipients](https://developers.wirebloom.com/md/reference/recipients.md): Recipients (beneficiaries): requirements per currency/country, CRUD, Confirmation/Verification of Payee, approval (customer tier or operator queue, D-14).
- [payments](https://developers.wirebloom.com/md/reference/payments.md): Payments, internal transfers, add money, exchanges and quotes, forward contracts and held rates, scheduled payments, direct debits (mandates, collections), bulk payments, approvals and funds requests.
- [activity](https://developers.wirebloom.com/md/reference/activity.md): Unified transactions (ledger view) with filters, search and exports; transaction detail with updates, annotations, attachments and confirmations; documents and asynchronous jobs.
- [providers](https://developers.wirebloom.com/md/reference/providers.md): Operator banking-partner configuration: provider connections (write-only credentials), routing rules, KYC connections, inbound provider webhooks and the provider event log.
- [public-api](https://developers.wirebloom.com/md/reference/public-api.md): Integrator access: API keys with scopes and integrator webhooks (HMAC-signed callbacks).
- [developer](https://developers.wirebloom.com/md/reference/developer.md): Self-serve developer sandboxes (D-42, FR-PLAT-07): registration (open mode) with email verification and abuse limits, the developer workspace, and the operator / platform controls (invite or open per operator, capped per environment).
- [simulations](https://developers.wirebloom.com/md/reference/simulations.md): Sandbox simulations (SC-38, P-89): every asynchronous outcome on demand — incoming payments and debits, payment status, returns and recalls, inbound recalls, exchange settlement, FX rate moves, direct-debit outcomes, card events, KYC outcomes, integrator events, statements, scheduled runs and provider outages.

## Optional

- [OpenAPI contract](https://developers.wirebloom.com/openapi.json): the machine-readable public integrator contract
- [Error catalogue](https://developers.wirebloom.com/errors): every problem type with status and retryability
- [Event catalogue](https://developers.wirebloom.com/events): webhook events and payload schemas
- [Changelog](https://developers.wirebloom.com/changelog): contract releases
- [Deprecations](https://developers.wirebloom.com/deprecations): deprecated operations and sunset dates
- [Full text](https://developers.wirebloom.com/llms-full.txt): every guide and the compact reference in one file