> ## 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.

# Errors

> Augustus API utilizes standard HTTP response codes to provide information about the success or failure of API requests.

## Status Codes

We follow the HTTP status code conventions. See the [HTTP Status Code Summary](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status) for more details.

**`2xx Range (Success):`** Codes in this range indicate a successful API request. This means the requested operation was completed as expected.

**`4xx Range (Client Errors):`** Codes in this range indicate an error related to the client's request. These errors may occur due to missing required parameters, payment failures, or other client-specific issues.

**`5xx Range (Server Errors):`** These codes indicate an issue with Augustus' servers. When you encounter a code in this range, it signifies an error on Augustus' side rather than an issue with the client's request.

Understanding these response codes helps developers work with Augustus API effectively and handle different scenarios appropriately, ensuring smooth and reliable integration.

## Error Structure

All errors return a consistent JSON structure in the response body:

<ResponseField name="message" type="string" required>
  A human-readable message explaining what went wrong. This message is suitable for displaying to end customers or for debugging purposes.
</ResponseField>

<ResponseField name="category" type="string">
  A broad category classifying the type of error. Possible values:

  * `api_error` - Server-side errors or unexpected issues
  * `invalid_request_error` - Client-side errors such as invalid parameters, authentication failures, or authorization issues
  * `rate_limiting` - Request was rejected due to rate limiting
  * `idempotency_error` - Request conflicts with a previous request using the same idempotency key
</ResponseField>

<ResponseField name="code" type="string">
  A short string indicating the specific error code. You can use this to handle errors programmatically.
</ResponseField>

<ResponseField name="param" type="string">
  When the error is parameter-specific, this field indicates which parameter caused the error. Useful for displaying validation errors near the appropriate form field.
</ResponseField>

<ResponseField name="docUrl" type="string">
  A URL linking to relevant documentation that provides more context about the error.
</ResponseField>

<ResponseField name="devMessage" type="string" deprecated>
  DEPRECATED: A human-readable message providing additional details about the error, primarily intended for developers.
</ResponseField>

<ResponseField name="statusCode" type="number" deprecated>
  DEPRECATED: The HTTP status code that corresponds to the error.
</ResponseField>

<ResponseField name="data" type="object" deprecated>
  DEPRECATED: Additional error context.
</ResponseField>

<ResponseExample>
  ```json Validation Error (400) theme={null}
  {
    "message": "Amount must be greater than 0",
    "category": "invalid_request_error",
    "param": "amount",
    "docUrl": "https://docs.getivy.de/reference/errors"
  }
  ```

  ```json Authentication Error (401) theme={null}
  {
    "message": "You are not authenticated. Please log in and try again",
    "category": "invalid_request_error",
    "docUrl": "https://docs.getivy.de/reference/authentication"
  }
  ```

  ```json Server Error (500) theme={null}
  {
    "message": "An unknown error occurred. Please reach out to support. Correlation id: abc-123-def",
    "category": "api_error"
  }
  ```
</ResponseExample>