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

# Payouts

> Send money anywhere: customers, partners, suppliers, or external accounts.

Send funds from an Augustus account to any external bank account or linked wallet via API or the Dashboard.

## Supported currencies

* **Fiat:** EUR, GBP, USD.
* **Stablecoins:** USDC (Ethereum, Solana, Polygon).

## Create a payout

<Tabs>
  <Tab title="2026-05-01">
    ```ts theme={null}
    import Augustus from '@augustusbank/typescript-sdk'

    const client = new Augustus()
    const payout = await client.payouts.create({
      source_account_id: 'your-eur-account-id',
      amount: '100',
      currency: 'EUR',
      reference: 'Invoice 1234',
      destination: {
        type: 'iban',
        iban: 'DE93500105176719451585',
        account_holder_name: 'Chris Simon',
      },
    })
    ```

    <Note>
      Find each Account ID in the Dashboard under **Accounts → Details**.
    </Note>

    [**POST** `/v1/payouts` in the API Reference →](/api-reference/payouts/create-payout)
  </Tab>

  <Tab title="2023-01-01">
    ```ts theme={null}
    import Ivy from '@getivy/node-sdk'

    const client = new Ivy()
    const payout = await client.payouts.create({
      amount: 100,
      currency: 'EUR',
      destination: {
        type: 'beneficiary',
        financialAddress: {
          type: 'iban',
          iban: {
            iban: 'DE93500105176719451585',
            accountHolderName: 'Chris Simon',
          },
        },
      },
    })
    ```

    <Note>
      Find each Account ID in the Dashboard under **Accounts → Details**.
    </Note>

    [**POST** `/api/service/payout` in the API Reference →](/api-reference/payout/create-a-payout)
  </Tab>
</Tabs>

## List payouts

Fetches all payouts on your account. Filter by type and paginate as needed.

<Tabs>
  <Tab title="2026-05-01">
    ```ts theme={null}
    import Augustus from '@augustusbank/typescript-sdk'

    const client = new Augustus()
    for await (const payout of client.payouts.list()) {
      // process payout
    }
    ```

    [**GET** `/v1/payouts` in the API Reference →](/api-reference/payouts/list-payouts)
  </Tab>

  <Tab title="2023-01-01">
    ```ts theme={null}
    import Ivy from '@getivy/node-sdk'

    const client = new Ivy()
    const { items } = await client.payouts.list({})
    for (const payout of items) {
      // process payout
    }
    ```

    [**POST** `/api/service/payout/list` in the API Reference →](/api-reference/payout/list-payouts)
  </Tab>
</Tabs>

## Retrieve a payout

Fetches the details of a single payout by its ID.

<Tabs>
  <Tab title="2026-05-01">
    ```ts theme={null}
    import Augustus from '@augustusbank/typescript-sdk'

    const client = new Augustus()
    const payout = await client.payouts.retrieve('payout_id')
    ```

    [**GET** `/v1/payouts/{id}` in the API Reference →](/api-reference/payouts/retrieve-payout)
  </Tab>

  <Tab title="2023-01-01">
    ```ts theme={null}
    import Ivy from '@getivy/node-sdk'

    const client = new Ivy()
    const payout = await client.payouts.retrieve({ id: 'payout_id' })
    ```

    [**POST** `/api/service/payout/retrieve` in the API Reference →](/api-reference/payout/retrieve-a-payout)
  </Tab>
</Tabs>

View payouts in the [Dashboard](https://dashboard.augustus.com/dashboard/payouts).

## Statuses

| Status    | Description                                 |
| --------- | ------------------------------------------- |
| `pending` | Request received, awaiting confirmation.    |
| `paid`    | Initiated and funds have left your account. |
| `failed`  | Could not be initiated.                     |

## Webhooks

Subscribe to payout events for real-time updates.

<Tabs>
  <Tab title="2026-05-01">
    ```ts theme={null}
    import Augustus from '@augustusbank/typescript-sdk'

    const client = new Augustus()
    const subscription = await client.webhookSubscriptions.create({
      url: 'https://your-server.com/webhooks',
      events: ['payout.created', 'payout.initiated', 'payout.paid', 'payout.failed'],
    })
    ```

    [**POST** `/v1/webhook_subscriptions` in the API Reference →](/api-reference/webhook-subscriptions/create-webhook-subscription)
  </Tab>

  <Tab title="2023-01-01">
    ```ts theme={null}
    import Ivy from '@getivy/node-sdk'

    const client = new Ivy()
    const subscription = await client.webhook.subscription.create({
      url: 'https://your-server.com/webhooks',
      events: ['payout.initiated', 'payout.paid', 'payout.failed'],
    })
    ```

    [**POST** `/api/service/webhook-subscription/create` in the API Reference →](/api-reference/webhook-subscription/create-a-webhook-subscription)
  </Tab>
</Tabs>

| Event              | Description                            |
| ------------------ | -------------------------------------- |
| `payout.created`   | A payout has been created.             |
| `payout.initiated` | The payout is being processed.         |
| `payout.paid`      | The payout has been successfully sent. |
| `payout.failed`    | The payout failed.                     |

***

### Closed-loop payout to a previous customer (2023-01-01 only)

Reference the customer's order ID instead of bank details:

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

const client = new Ivy()
const payout = await client.payouts.create({
  amount: 100,
  currency: 'EUR',
  destination: { type: 'customer', orderId: 'order_abc123' },
})
```
