Payouts - Augustus Docs

Payouts are the most flexible way to send money from your Augustus account to anyone: customers, partners, suppliers, or any external account. Common use cases include:

Trading: instantly pay your supplier after a successful trade or delivery
Marketplaces: pay sellers, drivers, or freelancers
Finance: move funds between treasury accounts
Consumer: customer withdrawals, refunds, or loyalty rewards
Payroll: pay out salaries, wages, or commissions

Supported Currencies & Chains

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

Create a Payout

Account IDs can be found in the Augustus Dashboard under Accounts → Details.

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',
      },
    },
  },
})

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',
  },
})

Closed-loop payouts

Pay back a customer who previously paid you in via Augustus by referencing their order ID. No bank details needed.

2023-01-01 (Ivy)

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' },
})

List Payouts

import Ivy from '@getivy/node-sdk'

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

import Augustus from '@augustusbank/typescript-sdk'

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

Retrieve a Payout

import Ivy from '@getivy/node-sdk'

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

import Augustus from '@augustusbank/typescript-sdk'

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

You can also view all your payouts in the Augustus Dashboard.

Statuses

Status	Description
`pending`	The payout request was received and is awaiting confirmation.
`paid`	The payout has been successfully initiated and funds have left your Augustus account.
`failed`	The payout could not be initiated.

Webhooks

Subscribe to payout events to react in real time without polling.

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'],
})

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'],
})

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.

​Supported Currencies & Chains

​Create a Payout

​Closed-loop payouts

​List Payouts

​Retrieve a Payout

​Statuses

​Webhooks

Supported Currencies & Chains

Create a Payout

Closed-loop payouts

List Payouts

Retrieve a Payout

Statuses

Webhooks