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

# Postman collection

> Run the sandbox deposit and payout flows for ACH, Fedwire and SWIFT from Postman before you write any code.

A ready-made Postman collection runs the sandbox flows end to end: open an account, receive a simulated deposit, save a counterparty, send a payout, check balances and events, and clean up. Use it to see the API work before you write a line of code, or to check that a sandbox key and its scopes are set up correctly.

The collection and its environment file are published at [github.com/augustus/postman-collections](https://github.com/augustus/postman-collections). They are generated from the published OpenAPI document, so the requests match the current 2026-05-01 API.

## What it runs

| Folder | What it does |
| - | - |
| **ACH**, **Fedwire**, **SWIFT** | Opens a USD operating account, simulates a USD 100.00 deposit, saves a counterparty, sends a USD 21.21 payout over that rail, checks balances and events, then drains and closes the account. |
| **Webhook** | Creates a webhook subscription to your receiver, sends a `ping.test` event and checks the delivery. Skipped when `webhookUrl` is empty. |

Each folder is independent. Run one at a time.

## Prerequisites

* Postman, app or web.
* A sandbox API key with `simulations:write`, `accounts:read`, `counterparties:write`, `payouts:read`, `payouts:write`, `deposits:read` and `events:read`. The Webhook folder also needs `webhook_subscriptions:write` and `webhook_deliveries:read`. `full_access` covers all of them. See [Scopes](/v1/scopes).
* For the Webhook folder, a public HTTPS receiver that answers with a 2xx status. A temporary inbox such as [webhook.site](https://webhook.site) is enough.

## Run it

<Steps>
  <Step title="Download the files">
    Get `augustus-v1.postman_collection.json` and `augustus-sandbox.postman_environment.json` from the [repository](https://github.com/augustus/postman-collections).
  </Step>

  <Step title="Import them">
    In Postman, select **Import** and add both files. The **Augustus Banking API Sandbox Flows** collection and the **Augustus Sandbox** environment appear.
  </Step>

  <Step title="Set your key">
    Select the **Augustus Sandbox** environment and set `apiKey` to your sandbox key. Set `webhookUrl` only if you run the Webhook folder.
  </Step>

  <Step title="Run a folder">
    Open the collection, choose a rail folder, select **Run folder** and keep the requests in their order.
  </Step>
</Steps>

<Note>
  The collection accepts only `https://api.sandbox.augustus.com` (or a local loopback address) as base URL, so it cannot run against production. Set `cleanupAccount` to `false` to keep the generated account and inspect it in the [Dashboard](https://dashboard.augustus.com/dashboard/accounts). Cleanup is best-effort: if a run fails before its last steps, the account stays open. Closed accounts and created counterparties remain visible in the sandbox history.
</Note>

To build the same flow step by step, or to simulate failures, returns and SWIFT specifics, follow [Simulations](/v1/simulations).


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