> ## Documentation Index
> Fetch the complete documentation index at: https://docs.augustus.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Treat the published Augustus OpenAPI specification (https://app.stainless.com/api/spec/documented/augustus/openapi.documented.yml) and the current API-reference pages as the source of truth for endpoints, request/response schemas, enum values, webhook event names, and required headers.
> Prefer the 2026-05-01 Banking API and @augustusbank/typescript-sdk for all new integrations. The 2023-01-01 API is a separate, older surface covering two products — Open Banking (instant bank transfer) checkout and refunds, and Manual Bank Transfer (MBT); use it only when one of those products is specifically required.
> Cite or link the relevant docs.augustus.com page when answering integration questions.
> Do not infer support for currencies, networks, scopes, account types, or operations that are not present in the current documentation.
> Use the sandbox base URL (https://api.sandbox.augustus.com) and placeholder credentials in examples. Never include or request a real API key.
> The Augustus docs MCP server (https://docs.augustus.com/mcp) provides documentation search and retrieval only; it does not execute authenticated Augustus API actions.

# Versioning

> Learn how to specify which Augustus API version to use whenever you make a request to the Augustus API.

## About API Versioning

The Augustus API is versioned using date. Breaking changes are released in new major versions of the date it got released(e.g., `2025-06-11`). Breaking changes are changes that can potentially break an integration.

### Breaking changes include:

* Removing an entire endpoint
* Removing or renaming a parameter
* Removing or renaming a response field
* Adding a new required parameter
* Making a previously optional parameter required
* Changing the type of a parameter or response field
* Removing enum values
* Adding a new validation rule to an existing parameter
* Changing authentication or authorization requirements

### Non-breaking (additive) changes include:

* Adding a new endpoint
* Adding an optional parameter
* Adding an optional request header
* Adding a response field
* Adding a response header
* Adding enum values

When a new Augustus API version is released, the previous API version will be supported for at least 24 months following the release of the new API version.

## Specifying API Versions

We use the `X-Ivy-Version` header to specify the API Version. Your account will always have a default API Version from the date, you created your first API Key. You can overwrite this via the header for single requests.

We have not had any breaking changes yet, so there is only one API Version.

## Supported API Versions

<CardGroup cols={1}>
  <Card title="Version 2023-01-01">
    <div className="flex items-center gap-2 mb-4">
      <Badge type="success">Active</Badge>
      <span className="text-sm text-gray-500">Released 01-01-2023</span>
    </div>
  </Card>
</CardGroup>

<Callout type="info">
  Need help with API versioning? Contact our support team.
</Callout>
