Reference

Changelog

Notable changes to the External API and to these docs. Most recent first. Subscribe to webhooks and watch this page to stay ahead of deprecations.

Versioning policy

The API is versioned in the path (/v1). Breaking changes ship under a new version — the current version keeps working. Deprecations are announced here and remain supported throughout a transition window before removal.

Within a version, changes are additive: we may introduce new fields and new enum values without a version bump. Build consumers to tolerate that.

To stay forward-compatible: branch your logic on the stable error type — never on message text — ignore unknown fields rather than rejecting them, and treat any unrecognised enum value as a safe default instead of failing.

Releases

v1.0.0 current 2026-07-06

Initial public API (quotes, orders, deposits, withdrawals, webhooks) on stable JSON contracts — and the launch of this documentation site.

AreaChange
quotesLock an exchange rate and fees for a currency pair.
ordersCommit a quote to a payout destination and track it to completion.
depositsCollect funds locally into a workspace balance.
withdrawalsPay out locally from a workspace balance.
KYCOnboard and verify entities before they transact.
webhooksSigned event notifications for state changes.
discoveryPer-currency capability discovery via /v1/currencies/*.
banking accountsManage the banking accounts behind deposits and withdrawals.
docsModern API documentation launched — this site.

Deprecated — the generic LOCALBANK deposit type is deprecated in favour of corridor-specific types (e.g. SEPA, PIX, and country-specific bank types). Discover the exact type per currency with GET /v1/currencies/{currency}/payin-schema. It is still returned on historical records for backward compatibility.

Upcoming

A cleaner, more consistent contract is planned: prefixed resource ids, a unified error envelope, 429 rate limiting with Retry-After, and standardized timestamps. It will ship under the versioning policy above — existing /v1 contracts keep working, and every change lands on this page first.

← Prev
Glossary