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.

​
Overview

A Deposit is any incoming transfer credited to one of your accounts. Augustus generates a deposit record when funds arrive on:
  • An Operating Account, using its rail-specific payment details (IBAN, sort code, ABA, etc.)
  • A Stablecoin Wallet, from a whitelisted external wallet on a supported chain
  • A Virtual Account, where the payment details are issued in your customer’s name (see Virtual Accounts)
You receive a webhook for every deposit and can reconcile or return it from there.
By default your account may not be enabled to accept inbound Deposits - payments could be returned automatically. Contact support to enable Deposits on the accounts you want to receive funds on.

​
Crypto deposits

To receive stablecoins, copy your wallet address from the Dashboard under Accounts → Details (or get it from the Augustus team during onboarding) and have the sender transfer from a whitelisted address only - the same destination configured for settlements.
Always double-check the address, blockchain network, and amount before initiating a crypto deposit. Transfers from non-whitelisted addresses or unsupported chains may be lost.

​
Webhook events

Subscribe to the following events to be notified when deposits and returns change state:
EventDescription
deposit.receivedA new deposit arrived on one of your accounts
return.initiatedA return has been initiated for a deposit
return.paid / return.succeededThe return was processed successfully
return.failedThe return could not be completed
return.returnedFunds from the return were credited back to the original sender

​
Retrieve a deposit

Deposit IDs shown here are placeholders. You’ll receive a real one in the deposit.received webhook payload, or by listing deposits.
import Augustus from '@augustusbank/typescript-sdk'

const client = new Augustus()
const deposit = await client.deposits.retrieve('your-deposit-id')

​
Returns

A return sends a deposit back to the original sender. Returns reference the parent deposit and emit return.* webhook events as they progress.

​
Create a return

import Augustus from '@augustusbank/typescript-sdk'

const client = new Augustus()
const ret = await client.returns.create({
  deposit_id: 'your-deposit-id',
})

​
Retrieve a return

import Augustus from '@augustusbank/typescript-sdk'

const client = new Augustus()
const ret = await client.returns.retrieve('your-return-id')

​
FAQ

With Deposits enabled, the payment is accepted and recorded as an unmatched deposit. You can reconcile it in your own system or return the funds. Without Deposits enabled, mismatched payments may be returned automatically.
Each successful deposit immediately increases the account’s available balance. See Balances for how to read current balances.
No - only full returns are supported. To send back a partial amount, use a payout instead.