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

# Status flow

> Understand the lifecycle of an Open Banking payment and Manual Bank Transfer.

Augustus tracks Open Banking and Manual Bank Transfer payments through the `order.status` field. Poll the order or subscribe to `order_updated` webhooks — status values are identical in both.

```ts 2023-01-01 theme={null}
import Ivy from '@getivy/node-sdk'

const client = new Ivy()
const order = await client.orders.retrieve({ id: 'your-order-id' })
```

## Statuses

| Status                | Description                                                                                                                                                                           | Next                                                    | Terminal                       |
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | ------------------------------ |
| `processing`          | Order created and payment flow started.                                                                                                                                               | `waiting_for_payment`, `paid`, `finalizing`, `canceled` | No                             |
| `waiting_for_payment` | Customer authorized the payment. Settlement pending. Not guaranteed. Skipped if settlement happens first.                                                                             | `paid`, `finalizing`, `failed`, `canceled`              | No (yes for direct settlement) |
| `finalizing`          | Payment received, booking verification in progress. Usually minutes, up to 48 hours. Can still be expired via API.                                                                    | `paid`, `canceled`                                      | No                             |
| `paid`                | Funds arrived or are guaranteed by Augustus. Settlement takes anywhere from instant to 3 business days depending on scheme. Only appears when Augustus holds your collection account. | `in_refund`                                             | Yes (unless refunded)          |
| `canceled`            | Session expired or was canceled. Late payments are auto-returned.                                                                                                                     | —                                                       | Yes                            |
| `failed`              | Funds did not arrive in time (6 days for `instant_preferred` / `standard`, 24 hours for `instant_only`). Late payments are auto-returned.                                             | —                                                       | Yes                            |
| `in_refund`           | Refund in flight to the customer's bank.                                                                                                                                              | `refunded`, `partially_refunded`                        | No                             |
| `refunded`            | Fully refunded.                                                                                                                                                                       | —                                                       | Yes                            |
| `partially_refunded`  | Part of the order was refunded.                                                                                                                                                       | `in_refund`                                             | No                             |

<Warning>
  Payments don't always follow the common path — handle every transition in your integration.
</Warning>