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.

Augustus tracks the status of Open Banking payments and Manual Bank Transfers through the order object. Use the order.status field to trigger actions in your system.

​
Monitoring payment status

There are two ways to track the current status of a payment:
1

Poll the order

2023-01-01 (Ivy)
import Ivy from '@getivy/node-sdk'

const client = new Ivy()
const order = await client.orders.retrieve({ id: 'your-order-id' })
2

Subscribe to webhooks

Receive real-time updates via the order_updated event. See Webhooks for setup.
Status values are identical between the API and webhook payloads.

​
Possible status values

​
processing

The order has been created successfully and the end user has started the payment flow.
  • Next possible statuses: waiting_for_payment, paid, finalizing, canceled
  • Terminal: no

​
canceled

The payment flow was not completed and the session expired, either by the system or by the merchant via API. If a customer sends funds with the correct payment details after cancellation, the incoming transaction is returned automatically.
  • Next possible statuses: none
  • Terminal: yes

​
waiting_for_payment

The user has authorized the payment and completed the session successfully. At this stage:
  • The user has authorized the payment within their bank
  • Settlement is still pending
  • Payment is not guaranteed
  • If settlement happens before the authorization notification is sent, this status is skipped and the order moves directly to paid

  • Next possible statuses: paid, finalizing, failed, canceled
  • Terminal: no (yes for payments with direct settlement)

​
finalizing

Payment received, finalizing booking verification. Typically completes in minutes, but may take up to 48 hours if additional verification is required. You can still expire the order at this stage via API.
  • Next possible statuses: paid, canceled
  • Terminal: no

​
failed

Money has not arrived within 6 days (when paymentSchemeSelection is instant_preferred or standard) or within 24 hours (instant_only) and will not arrive anymore. If money arrives after this point, it is returned automatically to the payer.
  • Next possible statuses: none
  • Terminal: yes
Money has successfully arrived in your account or is being guaranteed by Augustus.
  • Settlement can range from instant to 3 business days depending on the payment scheme
  • For instant payments, paid can sometimes arrive before waiting_for_payment. If so, waiting_for_payment is not sent at all.
  • This status only appears when Augustus holds your collection account, not for direct settlement

  • Next possible statuses: in_refund
  • Terminal: yes (unless you trigger a refund)

​
in_refund

The order is currently being refunded. Money is en route to the end user’s bank account.
  • Next possible statuses: refunded, partially_refunded
  • Terminal: no

​
refunded

The order has been fully refunded. Money has been sent to the end user’s bank account.
  • Next possible statuses: none
  • Terminal: yes

​
partially_refunded

The order has been partially refunded. Money has been sent to the end user’s bank account.
  • Next possible statuses: in_refund
  • Terminal: no
It’s important to handle all possible status transitions in your integration, as payments may not always follow the most common path.