Skip to main content

Versioning

URL-Based Versioning​

The BlockWyre API uses URL-based versioning. The version is part of the URL path:

VersionPrefixStatus
v3/v3/Current. New capabilities land here. See API v3.
v2/api/v2/Supported. Endpoints that have a v3 replacement are marked Deprecated.

Both versions take the same credentials (Authorization: APIKey, see Authentication), and you can call both from the same integration. Move one resource at a time.

Changes within a version​

Within a version, these changes can happen without notice, so build your client to tolerate them:

  • New fields in responses. Ignore the fields you do not recognize.
  • New optional query parameters or request fields.
  • New endpoints.

Before a breaking change or a deprecation takes effect, the BlockWyre team will notify you directly, with the change and its effective date. Existing behavior does not change without that notice.

Some changes are also signalled on the responses themselves. For example, while an Idempotency-Key grace period is open, a write sent without the header still runs and its response carries a Warning header (see Safe retries).

Deprecation Policy​

  • A deprecated v2 endpoint says so at the top of its page and links to its v3 replacement.
  • Some say so on every response too: Deprecation: true, and a Link header naming the v3 replacement's page with rel="successor-version". The v2 crypto writes do (see Crypto v3).
  • Deprecated endpoints keep working during a transition period.
  • Before a deprecated endpoint is removed, the BlockWyre team will notify you directly, with the date. A removed endpoint answers 410 Gone.

Support and Resources​

If you need assistance or have any questions, our support team is here to help. You can contact our support team at support@blockwyre.com.

Stay Updated​

Stay up-to-date with the latest news, updates, and features from BlockWyre by following us on social media:

We are excited to have you on board and look forward to seeing how you leverage BlockWyre's powerful tools to enhance your financial operations. Happy integrating!