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.

There are 2 ways to on-ramp funds via Augustus:
  1. Using Settlements, you can sweep part or all of your fiat balance to USDC using a saved wallet address. The swap and payout steps happen in one operation.
  2. Use FX + Payouts to swap your fiat balance into USDC and pay out USDC separately. This lets you swap custom amounts to manage FX, and pay out separately on demand.

​
Supported Currencies & Chains

  • Fiat: EUR, GBP, USD
  • Stablecoins: USDC (Ethereum, Solana, Polygon)
Minimum amount applies for on-ramps / off-ramps: minimum = 10 units of source currency.

​
How It Works

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

Check your balance

Make sure the source account has a positive balance before quoting a conversion.
import Augustus from '@augustusbank/typescript-sdk'

const client = new Augustus()
const balance = await client.accounts.retrieveBalance('your-eur-account-id')
2

Get a real-time exchange rate

Quote the conversion before executing it.
import Augustus from '@augustusbank/typescript-sdk'

const client = new Augustus()
const quote = await client.quotes.indicative.retrieve({
  source_currency: 'EUR',
  target_currency: 'USDC',
  source_amount: '100',
})
3

Execute the conversion

Swap fiat into USDC.
import Augustus from '@augustusbank/typescript-sdk'

const client = new Augustus()
const conversion = await client.conversions.create({
  source_account_id: 'your-eur-account-id',
  target_account_id: 'your-usdc-account-id',
  source_amount: '100',
})
4

Wait for the conversion to complete

Conversions are asynchronous. Poll for the terminal status or wait for a webhook event.
import Augustus from '@augustusbank/typescript-sdk'

const client = new Augustus()
const result = await client.conversions.retrieve(conversionId)

if (result.status !== 'completed') {
  // still pending or failed; back off and retry, or rely on webhooks
}
5

Pay out USDC to an external wallet

Send the converted USDC to a destination crypto wallet.
import Augustus from '@augustusbank/typescript-sdk'

const client = new Augustus()
const payout = await client.payouts.create({
  source_account_id: 'your-usdc-account-id',
  amount: '100',
  currency: 'USDC',
  reference: 'On-ramp payout',
  destination: {
    type: 'crypto_wallet',
    address: 'YourSolanaWalletAddress',
    blockchain: 'solana',
  },
})
6

Track the payout

Monitor payout status in the Dashboard or via webhooks. Funds usually arrive within minutes; on-chain settlement on Ethereum or Polygon can take up to 20 minutes.