> ## 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://api.augustus.com/openapi/2026-05-01.json) 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 surface covering the Pay by Bank products — Instant Bank Transfer (Open Banking) checkout and refunds, and Manual Bank Transfer (MBT); use it when one of those products is 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.

<Warning>
  **Test data only.** The sandbox is a test environment and does not carry the same data protections as production. Do not use production data or personal information (PII), such as real names, account numbers, addresses, or identity documents, for account holders, counterparties, references, or webhook payloads. Use fictitious values.
</Warning>

## Use Sandbox Mode

<Steps>
  <Step title="Enable Sandbox Mode">
    Switch the selector at the top right of the Dashboard from **Live** to **Sandbox**.
  </Step>

  <Step title="Use test API keys">
    Generate your test API key under [**Developer → Secrets**](https://dashboard.augustus.com/dashboard/developer/secrets) and use it against the sandbox base URL (see [Introduction](/v1/introduction)). Register your webhook endpoint under [**Developer → Webhooks**](https://dashboard.augustus.com/dashboard/developer/webhooks).
  </Step>

  <Step title="Create accounts">
    If your sandbox has no accounts yet, create the ones you want to test with: under [**Accounts**](https://dashboard.augustus.com/dashboard/accounts), choose **Create** for an operating account or an FBO program. See [Create accounts in the Dashboard](#create-accounts-in-the-dashboard).
  </Step>

  <Step title="Simulate activity">
    Simulate a deposit with **Initiate transactions → Simulate deposit** at the top right of the Dashboard: pick the account, amount, reference, and rail (ACH, Fedwire, or SWIFT). The deposit settles within seconds and shows up under [**Transactions**](https://dashboard.augustus.com/dashboard/transactions).
  </Step>

  <Step title="Go live">
    Once your account is activated, switch the selector back to **Live** and generate live API keys.
  </Step>
</Steps>

<Note>
  The **Live** / **Sandbox** selector only changes what the Dashboard shows; it does not affect your integration. Your API keys and base URL determine which mode you're in.
</Note>

## What you can do from the Dashboard

Every sandbox action has a Dashboard control or an API endpoint. The API walkthrough is [Simulations](/v1/simulations); this table maps each step to its Dashboard equivalent.

| Action | Dashboard | API |
| - | - | - |
| Create test API keys and webhook subscriptions | [Developer → Secrets](https://dashboard.augustus.com/dashboard/developer/secrets), [Developer → Webhooks](https://dashboard.augustus.com/dashboard/developer/webhooks) | [Authentication](/v1/authentication), [Webhooks](/v1/webhooks) |
| Open an operating account (USD, EUR, or GBP) | [Accounts](https://dashboard.augustus.com/dashboard/accounts) → **Create → Operating account** | `POST /v1/simulations/accounts` |
| Open an FBO program, add account holders, and create their accounts | [Accounts](https://dashboard.augustus.com/dashboard/accounts) → **Create → FBO program**, then the program's **Virtual accounts** tab → **Create account** | `POST /v1/simulations/account_programs`, `POST /v1/account_holders`, `POST /v1/accounts` |
| Receive a deposit | **Initiate transactions → Simulate deposit** | `POST /v1/simulations/deposits` |
| Create a payout | **Initiate transactions → Payout**, to a saved destination (Admin role and step-up required) | `POST /v1/payouts` against a saved counterparty |
| Set a payout's outcome (sent, failed, returned) | [Payments → Payouts](https://dashboard.augustus.com/dashboard/payouts) → payout details → **Sandbox Tools** | `POST /v1/simulations/payouts/{id}/send`, `/reject`, `/return` |
| Return a deposit you received | [Payments → Deposits](https://dashboard.augustus.com/dashboard/deposits) → deposit details → **Return** | `POST /v1/returns` |
| Drive a return you sent (`sent`, `failed`, or it comes back as `returned`) | Deposit details → **Sandbox Tools** | `POST /v1/simulations/returns/{id}/send`, `/reject`, `/return` |
| Inspect balances and booked transactions | [Accounts](https://dashboard.augustus.com/dashboard/accounts), [Transactions](https://dashboard.augustus.com/dashboard/transactions) | `GET /v1/accounts/{id}/balance`, `GET /v1/transactions` |
| Freeze, drain, and close an account | API only | `POST /v1/simulations/accounts/{id}/freeze`, `/unfreeze`, `/close` |

## Create accounts in the Dashboard

In the sandbox, you can open the accounts you need for testing from the Dashboard instead of the API. The **Create** button at the top of [**Accounts**](https://dashboard.augustus.com/dashboard/accounts) is shown in Sandbox Mode only, to Owners, Admins, Editors, and Operators.

<AccordionGroup>
  <Accordion title="Operating account">
    <Steps>
      <Step title="Open the form">
        Under **Accounts**, choose **Create → Operating account**.
      </Step>

      <Step title="Enter the details">
        Enter an **Account label** and pick the **Currency**: USD, EUR, or GBP.
      </Step>

      <Step title="Create the account">
        Choose **Create account**. The account appears in the accounts list with its own payment details, ready to receive a simulated deposit.
      </Step>
    </Steps>
  </Accordion>

  <Accordion title="FBO program and FBO accounts">
    An FBO account belongs to an FBO program and an account holder, so you create those first. See [FBO accounts](/docs/accounts/fbo-accounts) for the model.

    <Steps>
      <Step title="Create the FBO program">
        Under **Accounts**, choose **Create → FBO program**, enter a **Program label**, and choose **Create program**. This creates a USD FBO program at the sandbox bank.
      </Step>

      <Step title="Open the program">
        Open the program from the accounts list and go to its **Virtual accounts** tab.
      </Step>

      <Step title="Add an account holder">
        Choose **Create account**, then **Add new holder**. Pick the **Holder type**:

        * **US individual**: legal name, date of birth, SSN or ITIN, and residential address.
        * **Non-US individual**: legal name, date of birth, citizenship, government ID number, and residential address.
        * **Business**: two steps. First the business (legal name, EIN or SSN, year, state, and country of incorporation, and business address), then the person who controls and owns it.

        The holder is screened after you add it and shows as **In screening** until screening passes.
      </Step>

      <Step title="Create the account">
        Once screening passes, choose **Create account**, pick the **Account holder**, and confirm. The account opens immediately with its own account details.
      </Step>
    </Steps>
  </Accordion>
</AccordionGroup>

<Warning>
  Use fictitious holder data only. Do not enter real names, identification numbers, or addresses.
</Warning>

## Test a payout

<Steps>
  <Step title="Create a payout">
    Via the API against a saved counterparty (see [Payouts](/docs/payments/payouts)), or in the Dashboard with **Initiate transactions → Payout** to a saved destination. The payout starts as `initiated` and moves to `submitted` once the sandbox rail acknowledges it.
  </Step>

  <Step title="Open Sandbox Tools">
    Open the payout in its detail view under [**Payments → Payouts**](https://dashboard.augustus.com/dashboard/payouts).
  </Step>

  <Step title="Set the outcome">
    Choose **Simulate payout → succeeded** (the payout becomes `sent`), **failed** (the payout becomes `failed` with a `failure` reason), or **returned** (the payout becomes `returned` and the amount is credited back to your account). Verify status and webhooks.
  </Step>
</Steps>

## Test a return

<Steps>
  <Step title="Initiate a return">
    Return a deposit you received with [**POST** `/v1/returns`](/api-reference/returns/create-return), or from the deposit's detail view in the Dashboard. The deposit stays `settled`; the return is a linked resource with the same statuses as a payout (`initiated`, `submitted`, `sent`, `failed`, `returned`).
  </Step>

  <Step title="Follow the return">
    The deposits list shows the return's status next to the deposit, and the detail view lists it with its ID. A new return stays `initiated` until you drive it, the same way as a payout. **Sandbox Tools** on the deposit (or the return simulation endpoints) make it `sent`, let it fail (`failed`), or play the sender's bank sending it back, so it becomes `returned` with the funds credited to your account again.
  </Step>
</Steps>

## Production

Switch to live API keys and start with small amounts.

## What's next

* End-to-end API walkthrough: [Simulations](/v1/simulations) drives the same flows with the `/v1/simulations/*` endpoints instead of the Dashboard.
* No code needed: the [Postman collection](/v1/postman-collection) runs the ACH, Fedwire and SWIFT flows end to end from Postman.
* 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).

Bank and wallet destinations are saved as [counterparties](/docs/accounts/counterparties).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.