index.md

API version reference

Moov's API versioning follows the format vYYYY.QQ.BB, where

For example, v2026.01.00 is the initial release of the first quarter of 2026.

Lifecycle

Each quarter's API version is released at the start of that quarter. For example, v2026.07.00 will be released in July 2026. Once released, a version is considered stable and will only receive non-breaking changes.

When a new version is released, work begins on the next quarter's version, which is considered in development. The in development version receives new features, breaking changes, and non-breaking changes throughout the quarter. For example, once v2026.07.00 is officially released in July, v2026.10.00 enters in development and will eventually be available for early access.

Note - if no changes are made to the in development API version, that version will be skipped for an official release and will disappear from our public documentation.

If no API version is passed in your header request, Moov will default to v2024.01.00.

Available versions

The in development version of the API always represents the next quarter's API.

Setting the API version

To use a specific API version, set the X-Moov-Version header on every request:

X-Moov-Version: v2026.04.00

2026.07.00

2026.04.00

2026.01.00

Adds the instant-bank-credit payment method for real-time payments via RTP (FedNow support coming soon). While rtp-credit will continue to be supported, Moov strongly suggests moving to the instant-bank-credit payment method.

2025.07.00

2025.04.00

2025.01.00

Breaking changes

See the breaking changes guide for more details.

Moov SDKs

Moov's official SDKs set the X-Moov-Version header automatically. Each SDK release is pinned to a specific API version — you don't need to set the header yourself.

SDK versioning

SDKs are generated from each API version. SDK versioning will have the following format:

API version SDK version
v2026.07.00 26.4.x
v2026.07.00 26.7.0-dev.x

The table above uses v2026.07.00 as an example of an in development API version. The corresponding -dev.x SDK version indicates an in development version of the SDK and should be used with caution. The in-development API version will typically always be the next quarter's release.

Currently, Moov supports the following SDK versions for TypeScript, PHP, Java, Python, Ruby, .NET:

Other versions of the SDK should not be used as they will no longer receive updates.

Moov's Go SDK follows a different versioning system. Visit the Go SDK for specific information.

Custom SDKs and direct API integrations

If you generate your own SDK from our OpenAPI specification, or call the API directly, you are responsible for setting the X-Moov-Version header.

Each OpenAPI spec includes the version it corresponds to in the info.version field. Configure your HTTP client or generated SDK to send this value as the X-Moov-Version header with every request. For example, if info.version is v2026.04.00, every request should include:

X-Moov-Version: v2026.04.00

Most OpenAPI generators do not automatically set header defaults, so you will likely need to configure this in a request interceptor, middleware, or client constructor — depending on your HTTP client or generated SDK.