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

> Use Sandbox Mode to test your Augustus integration before going live with payments.

# Sandbox Mode

Sandbox Mode gives you test API keys and a sandbox where you can simulate deposits, payouts, and returns without moving real money.

<Frame>
  <img src="https://mintcdn.com/getivy/BzVAjXjYO5jKPpnR/images/Augustus-demo-dashboard-screenshot.jpg?fit=max&auto=format&n=BzVAjXjYO5jKPpnR&q=85&s=ec9a5532a02e7a13acf6eaec5d47bc3c" alt="Augustus Sandbox Mode Accounts" lightAlt="Augustus Sandbox Mode Test Transaction" darkAlt="Augustus Sandbox Mode Accounts" width="1280" height="618" data-path="images/Augustus-demo-dashboard-screenshot.jpg" />
</Frame>

## Use Sandbox Mode

<Steps>
  <Step title="Enable Sandbox Mode">
    Toggle **Sandbox Mode** in the user menu of the Dashboard.

    <Frame>
      <img src="https://mintcdn.com/getivy/BzVAjXjYO5jKPpnR/images/enter-sandbox-mode-screenshot.jpg?fit=max&auto=format&n=BzVAjXjYO5jKPpnR&q=85&s=a0e2bb5b1eed3c6d894d1d274ae716cd" alt="Sandbox Mode Selector" title="Sandbox Mode Selector" style={{ width:"34%" }} width="803" height="1243" data-path="images/enter-sandbox-mode-screenshot.jpg" />
    </Frame>
  </Step>

  <Step title="Use test API keys">
    Find and generate your test API key under **Developer → Secrets**. Use it with the sandbox base URL — see the API reference for URLs.
  </Step>

  <Step title="Simulate activity">
    Simulate a deposit in the Dashboard under **Payments → Deposits → \[+ Create deposit]** to trigger test payments in the desired account.
  </Step>

  <Step title="Go live">
    Once your account is activated, switch off Sandbox Mode and generate live API keys.
  </Step>
</Steps>

<Note>
  The Sandbox Mode toggle in the Dashboard does not affect your integration. Your API keys and base URL determine which mode you're in.
</Note>

## Test a payout

<Steps>
  <Step title="Create a payout via the API">
    Use any counterparty.
  </Step>

  <Step title="Open Sandbox Tools">
    Open the payout in its detail view.
  </Step>

  <Step title="Set the outcome">
    Toggle success or failure. Verify status and webhooks.

    <Frame caption="Sandbox tools in the details view of a payout">
      <img src="https://mintcdn.com/getivy/J1t6OrlJaZyvflSC/images/docs/simulationOnUserPayouts.png?fit=max&auto=format&n=J1t6OrlJaZyvflSC&q=85&s=797ae26a9224d2fbfe790c6ac77b425d" alt="Sandbox tools for simulating payout flows" width="904" height="366" data-path="images/docs/simulationOnUserPayouts.png" />
    </Frame>
  </Step>
</Steps>

## Simulate outgoing transactions manually

Under the **Simulations** tab in the Developer section, simulate outgoing payouts with any amount, remittance text, and outcome.

## Test a return

<Steps>
  <Step title="Initiate a return">
    Initiate a return via API or manually from the Augustus Dashboard.
  </Step>

  <Step title="Open Sandbox Tools">
    Find the deposit and open its detail view to access Sandbox Tools.

    <Frame>
      <img src="https://mintcdn.com/getivy/wDXiTOloYd-musSx/images/deposit-return-screenshot.jpg?fit=max&auto=format&n=wDXiTOloYd-musSx&q=85&s=e0fc86fc96f1c0ee9fc799bc6f74eb85" alt="Deposit Return Screenshot" title="Deposit Return Screenshot" style={{ width:"47%" }} width="619" height="1280" data-path="images/deposit-return-screenshot.jpg" />
    </Frame>
  </Step>
</Steps>

## Production

Switch to live API keys and start with small amounts.

## What's next

* Sandbox base URLs: [2026-05-01](/v1/introduction) / [2023-01-01](/reference/introduction).
* Webhooks: [2026-05-01](/v1/webhooks) / [2023-01-01](/webhook-getting-started/introduction).