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.

Refunds let you return money to your customers (instantly where possible) using your available Augustus balance. Supports both full and partial refunds, with instant rails (SEPA Instant, Faster Payments) when available.

​
When to Use Refunds

  • Customer returns or cancels an order
  • Payment errors or duplicate charges
  • Loyalty, goodwill, or compliance reasons

​
Requirements

  • You must have enough available balance (not pending) to cover the refund
  • You can issue multiple refunds per order, but not more than the original amount
  • Optionally, set a reserve to ensure funds for refunds

​
How to Issue a Refund

​
Dashboard

  1. Go to the Orders page in the Dashboard
  2. Find the order and select Refund Order
  3. Enter the amount (full or partial) and optional description
  4. Confirm the refund

​
API

Provide the orderId and (optionally) the amount or a custom payment reference.
2023-01-01 (Ivy)
import Ivy from '@getivy/node-sdk'

const client = new Ivy()
const refund = await client.refunds.create({
  orderId: 'order_abc123',
  amount: 100,
  displayedPaymentReference: 'display this to user!',
})
Augustus sends the refund to the customer’s bank account using instant rails where possible, falling back to standard rails otherwise. Refunds usually appear instantly but can take up to 2 business days depending on the bank.

​
Refund Statuses

StatusDescription
pendingRefund is initiated and processing
succeededRefund completed successfully and funds returned
partially_refundedPartial refund completed
failedRefund failed due to insufficient balance or technical issues
You can also track refund status in the Augustus Dashboard.

​
Webhooks

Subscribe to refund events to react in real time without polling.
2023-01-01 (Ivy)
import Ivy from '@getivy/node-sdk'

const client = new Ivy()
const subscription = await client.webhook.subscription.create({
  url: 'https://your-server.com/webhooks',
  events: ['refund.initiated', 'refund.succeeded', 'refund.failed'],
})
EventDescription
refund.initiatedThe refund has been created and is processing.
refund.succeededThe refund completed successfully.
refund.failedThe refund failed.