Skip to main content

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

​
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
}

​
Retrieve a Payout

import Ivy from '@getivy/node-sdk'

const client = new Ivy()
const payout = await client.payouts.retrieve({ id: 'payout_id' })
You can also view all your payouts in the Augustus Dashboard.

​
Statuses

StatusDescription
pendingThe payout request was received and is awaiting confirmation.
paidThe payout has been successfully initiated and funds have left your Augustus account.
failedThe 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'],
})
EventDescription
payout.createdA payout has been created.
payout.initiatedThe payout is being processed.
payout.paidThe payout has been successfully sent.
payout.failedThe payout failed.