# Augustus Docs ## Docs - [List account programs](https://docs.augustus.com/api-reference/account-programs/list-account-programs.md): Lists account programs for the merchant with cursor-based pagination. - [Retrieve account program](https://docs.augustus.com/api-reference/account-programs/retrieve-account-program.md): Retrieves an account program by ID. - [Retrieve account program balance](https://docs.augustus.com/api-reference/account-programs/retrieve-account-program-balance.md): Returns the aggregated available balance for all virtual accounts under the account program. - [Close account](https://docs.augustus.com/api-reference/accounts/close-account.md): Closes an account - [Create account](https://docs.augustus.com/api-reference/accounts/create-account.md): Creates a new account. - [Freeze account](https://docs.augustus.com/api-reference/accounts/freeze-account.md): Freezes an account - [List accounts](https://docs.augustus.com/api-reference/accounts/list-accounts.md): Returns a paginated list of accounts. - [Retrieve account](https://docs.augustus.com/api-reference/accounts/retrieve-account.md): Retrieves an account by ID. - [Retrieve account balance](https://docs.augustus.com/api-reference/accounts/retrieve-account-balance.md): Retrieves the available balance for an account. - [Unfreeze account](https://docs.augustus.com/api-reference/accounts/unfreeze-account.md): Unfreezes an account - [Introspect current API key](https://docs.augustus.com/api-reference/api-key/introspect-current-api-key.md): Returns the API key resource for the key authenticating this request. Useful for verifying which key is in use and discovering its current authorization context without inferring it from rejected requests. - [List API versions](https://docs.augustus.com/api-reference/api-versions/list-api-versions.md): Returns the catalogue of publicly available Augustus Banking API versions, ordered oldest to newest. New accounts and unpinned merchants resolve to the entry with `is_latest: true`. Public: no authentication required. - [List Banks](https://docs.augustus.com/api-reference/bank/list-banks.md): Get a list of banks. You can filter by group, capability and market. - [Retrieve a Bank](https://docs.augustus.com/api-reference/bank/retrieve-a-bank.md): Retrieve a bank object by its id. The id is a unique identifier of the bank within Ivy. - [Search a Bank](https://docs.augustus.com/api-reference/bank/search-a-bank.md): You can retrieve a list of banks by a given search string. If the search string is empty (""), a default list of banks is returned. On top, you can filter results by group, capability and market. - [Retrieve Account Balance](https://docs.augustus.com/api-reference/banking/retrieve-account-balance.md): Retrieve the balance of your Ivy account. The balance is the money currently available on your Ivy account. It is broken down by currency. - [Retrieve your Capabilities](https://docs.augustus.com/api-reference/capabilities/retrieve-your-capabilities.md): Retrieve the capabilities of your Ivy account. The capabilities are broken down by market and by product. - [Create a Checkout Session](https://docs.augustus.com/api-reference/checkout/create-a-checkout-session.md): Creates a Checkout Session for the merchant corresponding to the given API key. See [the guide](https://docs.getivy.de/docs/payment-integration) for more information. - [Expire a Checkout Session](https://docs.augustus.com/api-reference/checkout/expire-a-checkout-session.md): Expire a Checkout Session by Ivy id. By expiring a Checkout Session, users will not be able to access this Checkout Session anymore. - [Retrieve a Checkout Session](https://docs.augustus.com/api-reference/checkout/retrieve-a-checkout-session.md): Retrieve a Checkout Session and its details by Ivy id. - [Create conversion](https://docs.augustus.com/api-reference/conversions/create-conversion.md): Creates and executes a conversion. - [List conversions](https://docs.augustus.com/api-reference/conversions/list-conversions.md): Returns a paginated list of conversions. - [Retrieve conversion](https://docs.augustus.com/api-reference/conversions/retrieve-conversion.md): Retrieves a conversion by ID. - [Create a Customer](https://docs.augustus.com/api-reference/customer/create-a-customer.md): Create a new Customer representing your Customers. You can use the Customer to simplify the checkout process for returning journeys. - [Delete a Customer](https://docs.augustus.com/api-reference/customer/delete-a-customer.md): Delete a Customer by wiping personal data and marking the customer as deleted. - [Retrieve a Customer](https://docs.augustus.com/api-reference/customer/retrieve-a-customer.md): Retrieve a Customer Object by its id. - [Search Customers](https://docs.augustus.com/api-reference/customer/search-customers.md): Search for customers you have previously created using filters, e.g. by email. - [Update a Customer](https://docs.augustus.com/api-reference/customer/update-a-customer.md): Update the Customer details - [Retrieve a deposit](https://docs.augustus.com/api-reference/deposit/retrieve-a-deposit.md): Retrieves a deposit by its ID. - [List deposits](https://docs.augustus.com/api-reference/deposits/list-deposits.md): Lists deposits for the merchant with cursor-based pagination. - [Retrieve deposit](https://docs.augustus.com/api-reference/deposits/retrieve-deposit.md): Retrieves a deposit by ID. - [List events](https://docs.augustus.com/api-reference/events/list-events.md): Lists webhook events for the merchant with cursor-based pagination. Events are retained for 30 days. - [Retrieve event](https://docs.augustus.com/api-reference/events/retrieve-event.md): Retrieves a webhook event by ID. - [Execute FX](https://docs.augustus.com/api-reference/fx/execute-fx.md): Execute a standalone foreign exchange transaction. - [Retrieve Exchange Rate](https://docs.augustus.com/api-reference/fx/retrieve-exchange-rate.md): Retrieve the current exchange rate for a given currency pair. The rate is not guaranteed for any following transactions. - [Retrieve FX details](https://docs.augustus.com/api-reference/fx/retrieve-fx-details.md): Retrieve the details of a past fx transfer using the fxId. - [Create an Order](https://docs.augustus.com/api-reference/order/create-an-order.md): Create a new order. By creating a new order, you will create a new settlement destination which you can use to settle expected incoming payments efficiently. After creating the order, Ivy provides you with a destination for the expected incoming payment. As soon as a payment with the same details ar… - [Expire an Order](https://docs.augustus.com/api-reference/order/expire-an-order.md): Manually expire an order before its natural expiration time. - [Retrieve an Order](https://docs.augustus.com/api-reference/order/retrieve-an-order.md): Retrieve details of an order. You can retrieve the order by passing either the internal Ivy order id or the `referenceId` you specified when creating a Checkout Session to the `id` field. - [Create a payout](https://docs.augustus.com/api-reference/payout/create-a-payout.md): Create a payout for a merchant. - [List payouts](https://docs.augustus.com/api-reference/payout/list-payouts.md): List payouts for a merchant. - [Payout available balances](https://docs.augustus.com/api-reference/payout/payout-available-balances.md): Payout all available balances of your account to the preconfigured beneficiary bank account or wallet. If you want to handle payouts in a more dynamic and granular way, please use the POST /payout/create endpoint. - [Retrieve a payout](https://docs.augustus.com/api-reference/payout/retrieve-a-payout.md): Retrieve a payout object by id. - [Create payout](https://docs.augustus.com/api-reference/payouts/create-payout.md): Creates a new payout. - [List payouts](https://docs.augustus.com/api-reference/payouts/list-payouts.md): Lists payouts for the merchant with cursor-based pagination. - [Retrieve payout](https://docs.augustus.com/api-reference/payouts/retrieve-payout.md): Retrieves a payout by ID. - [Get indicative quote](https://docs.augustus.com/api-reference/quotes/get-indicative-quote.md): Returns an indicative quote for a currency pair. Not persisted or holdable. - [Retrieve quote](https://docs.augustus.com/api-reference/quotes/retrieve-quote.md): Retrieves a persisted quote by ID. - [Create a refund](https://docs.augustus.com/api-reference/refund/create-a-refund.md): Creates a refund for the specified order. The order can be specified either by Ivy's internal `orderId` or by the `referenceId` provided by the merchant during checkout creation. If the refund should only be partial, you can specifiy this with the `amount` parameter. - [Retrieve a refund](https://docs.augustus.com/api-reference/refund/retrieve-a-refund.md): Returns refund details and Id of refunded order. - [Create a return](https://docs.augustus.com/api-reference/return/create-a-return.md): Creates a return for a deposit. - [Retrieve a return](https://docs.augustus.com/api-reference/return/retrieve-a-return.md): Retrieves a return by its ID. - [Create return](https://docs.augustus.com/api-reference/returns/create-return.md): Initiates a return of funds from a deposit to the source. - [List returns](https://docs.augustus.com/api-reference/returns/list-returns.md): Lists deposit returns for the merchant with cursor-based pagination. - [Retrieve return](https://docs.augustus.com/api-reference/returns/retrieve-return.md): Retrieves a return by ID. - [List scopes](https://docs.augustus.com/api-reference/scopes/list-scopes.md): Returns the catalogue of scopes available to API keys. The list is filtered by the `Api-Version` request header and defaults to the latest version when the header is omitted. Public: no authentication required. - [Create a Subaccount](https://docs.augustus.com/api-reference/subaccount/create-a-subaccount.md): Create a Subaccount which can be used to reconcile orders, refunds and payouts more easily. - [Retrieve a Subaccount](https://docs.augustus.com/api-reference/subaccount/retrieve-a-subaccount.md): Retrieve a Subaccount by id. - [List transactions](https://docs.augustus.com/api-reference/transactions/list-transactions.md): Retrieve a paginated list of transactions for the specified time period - [Verify payee bank account](https://docs.augustus.com/api-reference/vop/verify-payee-bank-account.md): Verify that the provided account holder name matches the bank account details. - [List webhook deliveries](https://docs.augustus.com/api-reference/webhook-deliveries/list-webhook-deliveries.md): Lists webhook deliveries for the merchant with cursor-based pagination. Deliveries are retained for 30 days. - [Redeliver webhook](https://docs.augustus.com/api-reference/webhook-deliveries/redeliver-webhook.md): Triggers a fresh delivery attempt of the event to the same webhook subscription. - [Retrieve webhook delivery](https://docs.augustus.com/api-reference/webhook-deliveries/retrieve-webhook-delivery.md): Retrieves a webhook delivery by ID. - [conversion.completed](https://docs.augustus.com/api-reference/webhook-events/conversioncompleted.md): Sent when a conversion has completed successfully. - [conversion.created](https://docs.augustus.com/api-reference/webhook-events/conversioncreated.md): Sent when a conversion is created and processing has started. - [conversion.failed](https://docs.augustus.com/api-reference/webhook-events/conversionfailed.md): Sent when a conversion has failed. - [deposit.received](https://docs.augustus.com/api-reference/webhook-events/depositreceived.md): Sent when a deposit is received - [payout.created](https://docs.augustus.com/api-reference/webhook-events/payoutcreated.md): Sent when a payout is created. - [payout.failed](https://docs.augustus.com/api-reference/webhook-events/payoutfailed.md): Sent when a payout has failed. - [payout.initiated](https://docs.augustus.com/api-reference/webhook-events/payoutinitiated.md): Sent when a payout is initiated and processing has started. - [payout.paid](https://docs.augustus.com/api-reference/webhook-events/payoutpaid.md): Sent when a payout has been successfully delivered. - [ping.test](https://docs.augustus.com/api-reference/webhook-events/pingtest.md): Sent when a merchant explicitly triggers a test delivery to one of their webhook subscriptions. Does not reflect any real business activity; handlers should short-circuit on this event type. - [return.failed](https://docs.augustus.com/api-reference/webhook-events/returnfailed.md): Sent when a deposit return has failed. - [return.initiated](https://docs.augustus.com/api-reference/webhook-events/returninitiated.md): Sent when a deposit return has been initiated. - [return.paid](https://docs.augustus.com/api-reference/webhook-events/returnpaid.md): Sent when a deposit return outbound payment has been paid. - [return.returned](https://docs.augustus.com/api-reference/webhook-events/returnreturned.md): Sent when a succeeded deposit return was reversed or returned. - [Create a webhook subscription](https://docs.augustus.com/api-reference/webhook-subscription/create-a-webhook-subscription.md): Creates a webhook subscription that sends various events from Ivy to a specified url. There can be multiple subscriptions per app. - [Delete a webhook subscription](https://docs.augustus.com/api-reference/webhook-subscription/delete-a-webhook-subscription.md): Deletes a webhook subscription. - [List webhook subscriptions](https://docs.augustus.com/api-reference/webhook-subscription/list-webhook-subscriptions.md): Lists all webhook subscriptions that are registered for the merchant. The results are paginated and provided in chronological order. - [Ping a webhook subscription](https://docs.augustus.com/api-reference/webhook-subscription/ping-a-webhook-subscription.md): Sends a test ping to verify webhook subscription endpoint connectivity. - [Update a webhook subscription](https://docs.augustus.com/api-reference/webhook-subscription/update-a-webhook-subscription.md): Updates the url or subcribed to events for a webhook subscription. This can be used via the app or via the API by providing an API key. - [Create webhook subscription](https://docs.augustus.com/api-reference/webhook-subscriptions/create-webhook-subscription.md): Creates a new webhook subscription. - [Delete webhook subscription](https://docs.augustus.com/api-reference/webhook-subscriptions/delete-webhook-subscription.md): Permanently deletes a webhook subscription. This cannot be undone. - [List webhook subscriptions](https://docs.augustus.com/api-reference/webhook-subscriptions/list-webhook-subscriptions.md): Lists webhook subscriptions for the merchant with cursor-based pagination. - [Retrieve webhook subscription](https://docs.augustus.com/api-reference/webhook-subscriptions/retrieve-webhook-subscription.md): Retrieves a webhook subscription by ID. - [Send test event](https://docs.augustus.com/api-reference/webhook-subscriptions/send-test-event.md): Dispatches a signed `ping.test` event to this subscription's URL through the same pipeline as real events. Useful for verifying your receiver's reachability and signature verification in any environment without creating a real business event. Test-event failures do not affect the subscription's heal… - [Update webhook subscription](https://docs.augustus.com/api-reference/webhook-subscriptions/update-webhook-subscription.md): Updates the URL and/or subscribed events. - [Trigger a specific webhook](https://docs.augustus.com/api-reference/webhook/trigger-a-specific-webhook.md): This endpoint allows you to trigger a specific webhook by its ID. - [checkout_session_completed](https://docs.augustus.com/api-reference/webhookeventexamples/checkout_session_completed.md): A checkout session has been completed - [checkout_session_created](https://docs.augustus.com/api-reference/webhookeventexamples/checkout_session_created.md): A checkout session has been created - [checkout_session_expired](https://docs.augustus.com/api-reference/webhookeventexamples/checkout_session_expired.md): A checkout session has expired - [checkout_session_updated](https://docs.augustus.com/api-reference/webhookeventexamples/checkout_session_updated.md): A checkout session has been updated - [data_session_completed](https://docs.augustus.com/api-reference/webhookeventexamples/data_session_completed.md): A data session has been completed - [deposit.received](https://docs.augustus.com/api-reference/webhookeventexamples/depositreceived.md): A deposit has been received - [fx.failed](https://docs.augustus.com/api-reference/webhookeventexamples/fxfailed.md): An FX has failed - [fx.initiated](https://docs.augustus.com/api-reference/webhookeventexamples/fxinitiated.md): An FX has been initiated - [fx.succeeded](https://docs.augustus.com/api-reference/webhookeventexamples/fxsucceeded.md): An FX has succeeded - [merchant_updated](https://docs.augustus.com/api-reference/webhookeventexamples/merchant_updated.md): Your merchant account has been updated - [order_created](https://docs.augustus.com/api-reference/webhookeventexamples/order_created.md): An order has been created - [order_updated](https://docs.augustus.com/api-reference/webhookeventexamples/order_updated.md): An order has been updated - [payout_created](https://docs.augustus.com/api-reference/webhookeventexamples/payout_created.md): A payout has been created - [payout_report_requested](https://docs.augustus.com/api-reference/webhookeventexamples/payout_report_requested.md): A payout report has been requested - [payout_updated](https://docs.augustus.com/api-reference/webhookeventexamples/payout_updated.md): A payout has been updated - [payout.failed](https://docs.augustus.com/api-reference/webhookeventexamples/payoutfailed.md): A payout has failed - [payout.initiated](https://docs.augustus.com/api-reference/webhookeventexamples/payoutinitiated.md): A payout has been initiated - [payout.paid](https://docs.augustus.com/api-reference/webhookeventexamples/payoutpaid.md): A payout has been paid - [refund_failed](https://docs.augustus.com/api-reference/webhookeventexamples/refund_failed.md): A refund initiated with `/merchant/payment/refund` failed - [refund_succeeded](https://docs.augustus.com/api-reference/webhookeventexamples/refund_succeeded.md): A refund initiated with `/merchant/payment/refund` succeeded - [refund.failed](https://docs.augustus.com/api-reference/webhookeventexamples/refundfailed.md): A refund initiated with `/refund/create` failed - [refund.initiated](https://docs.augustus.com/api-reference/webhookeventexamples/refundinitiated.md): A refund initiated with `/refund/create` - [refund.succeeded](https://docs.augustus.com/api-reference/webhookeventexamples/refundsucceeded.md): A refund initiated with `/refund/create` succeeded - [return.failed](https://docs.augustus.com/api-reference/webhookeventexamples/returnfailed.md): A return has failed - [return.initiated](https://docs.augustus.com/api-reference/webhookeventexamples/returninitiated.md): A return has been initiated - [return.returned](https://docs.augustus.com/api-reference/webhookeventexamples/returnreturned.md): A return has been returned - [return.succeeded](https://docs.augustus.com/api-reference/webhookeventexamples/returnsucceeded.md): A return has succeeded - [Test](https://docs.augustus.com/api-reference/webhookeventexamples/test.md): Can be triggered with `/webhook-subscription/ping` to test the integration - [user_payout.failed](https://docs.augustus.com/api-reference/webhookeventexamples/user_payoutfailed.md): A customer payout has failed - [user_payout.initiated](https://docs.augustus.com/api-reference/webhookeventexamples/user_payoutinitiated.md): A customer payout has been initiated - [user_payout.paid](https://docs.augustus.com/api-reference/webhookeventexamples/user_payoutpaid.md): A customer payout has been paid - [Off-Ramp](https://docs.augustus.com/docs/On-Offramp/offramp.md): Deposit crypto funds to your Augustus wallet and off-ramp to fiat to fund your fiat operations - [On-Ramp](https://docs.augustus.com/docs/On-Offramp/onramp.md): On-ramp fiat funds to USDC to fund your crypto operations - [Balances](https://docs.augustus.com/docs/accounts/balances.md): Hold fiat and stablecoin funds in your Augustus account - [Overview](https://docs.augustus.com/docs/accounts/overview.md): Create Accounts and Balances with Augustus - [Transaction Reporting](https://docs.augustus.com/docs/accounts/transaction-list.md): Retrieve transactions for your accounts in JSON format via API. - [Virtual Accounts](https://docs.augustus.com/docs/accounts/virtual-accounts.md): Sub-ledgered balances with unique account identifiers, under a bank account you hold with Augustus. - [Stablecoin Wallets](https://docs.augustus.com/docs/accounts/wallet.md): How to enable Stablecoin Wallets and find wallet information for stablecoin payments - [Core Concepts](https://docs.augustus.com/docs/basics/concepts.md): The capabilities Augustus offers: accepting payments, sending payouts, holding balances, converting currencies, and more. - [Dashboard](https://docs.augustus.com/docs/basics/dashboard.md): Learn the basics of the Augustus Dashboard. - [Welcome to Augustus](https://docs.augustus.com/docs/basics/introduction.md): About Augustus, our platform, and how to get up and running fast. - [Test Mode](https://docs.augustus.com/docs/basics/test-mode-sandbox.md): Use Test Mode to test your Augustus integration before going live with payments. - [Deposits](https://docs.augustus.com/docs/payin/deposits.md): Receive incoming fiat or crypto transfers directly into your accounts. - [Ecommerce](https://docs.augustus.com/docs/payin/instant-bank-transfer/best-practices/ecommerce.md): Best practices on how to integrate Augustus payments into your e-commerce checkout. - [Financial Services](https://docs.augustus.com/docs/payin/instant-bank-transfer/best-practices/financial-services.md): Best practices on integrating Augustus deposits into your financial service or crypto app. - [Financial Services](https://docs.augustus.com/docs/payin/instant-bank-transfer/best-practices/withdrawals.md): Best practices on integrating Augustus withdrawals into your financial service or crypto app. - [Failure Reasons](https://docs.augustus.com/docs/payin/instant-bank-transfer/failure-reasons.md): Understand the main failure reasons for Open Banking payments and how to handle them in your integration. - [Client Integration](https://docs.augustus.com/docs/payin/instant-bank-transfer/iframe.md): Optimise your client integration of Augustus Checkout for the best user experience on any platform. - [Integration Flow](https://docs.augustus.com/docs/payin/instant-bank-transfer/payment-integration.md): Everything you need to let customers pay in money via Open Banking - [Status Flow](https://docs.augustus.com/docs/payin/instant-bank-transfer/payment-status.md): Understand the lifecycle of an Open Banking payment and Manual Bank Transfer. - [Remember Me](https://docs.augustus.com/docs/payin/instant-bank-transfer/remember-me.md): Boost conversion by simplifying your customers' checkout experience - [Test Your Integration](https://docs.augustus.com/docs/payin/instant-bank-transfer/test-your-integration.md) - [UX Best Practice](https://docs.augustus.com/docs/payin/mbt/best-practices.md): UX best practice for integrating Manual Bank Transfer into your checkout. - [Integration Flow](https://docs.augustus.com/docs/payin/mbt/mbt.md): Allow your customers to transfer money from their bank account manually. - [Overview](https://docs.augustus.com/docs/payin/payin-intro.md): Introduction to payin flows and concepts. - [Overview](https://docs.augustus.com/docs/payout/overview.md): Introduction to payout flows and concepts. - [Payouts](https://docs.augustus.com/docs/payout/payout.md): Send money anywhere: customers, partners, suppliers, or external accounts. - [Refunds](https://docs.augustus.com/docs/payout/refunds-payouts.md): Refund all or part of an order quickly and reliably. - [Settlements](https://docs.augustus.com/docs/payout/settlements.md): How to settle your Operating Account balance to an external account - [Test Your Integration](https://docs.augustus.com/docs/payout/test-your-integration.md) - [Versioning](https://docs.augustus.com/reference/api-versions.md): Learn how to specify which Augustus API version to use whenever you make a request to the Augustus API. - [Authentication](https://docs.augustus.com/reference/authentication.md): The Augustus API uses API Keys to authenticate requests. You can view and manage your API Key in the Augustus Dashboard. - [Errors](https://docs.augustus.com/reference/errors.md): Augustus API utilizes standard HTTP response codes to provide information about the success or failure of API requests. - [Idempotency](https://docs.augustus.com/reference/idempotency.md): Use idempotency keys to safely retry POST requests without creating duplicate operations. - [Introduction](https://docs.augustus.com/reference/introduction.md) - [Metadata](https://docs.augustus.com/reference/metadata.md): Most updatable Augustus objects have a Metadata parameter. You can use this parameter to attach arbitrary key-value data to these Augustus objects. - [Authentication](https://docs.augustus.com/v1/authentication.md): The Banking API uses bearer tokens in the standard Authorization header to authenticate requests. - [Errors](https://docs.augustus.com/v1/errors.md): The Banking API returns consistent, structured error responses with machine-readable codes for programmatic handling. - [Idempotency](https://docs.augustus.com/v1/idempotency.md): Safely retry POST requests using the Idempotency-Key header to prevent duplicate operations. - [Introduction](https://docs.augustus.com/v1/introduction.md): Programmatic access to your Augustus account: send payouts, manage accounts, run conversions, and more. - [Pagination](https://docs.augustus.com/v1/pagination.md): List endpoints use cursor-based pagination with opaque cursors for efficient, consistent traversal. - [Scopes](https://docs.augustus.com/v1/scopes.md): Each API key carries one or more scopes that gate which resources and actions it can touch. - [Versioning](https://docs.augustus.com/v1/versioning.md): The API uses date-based versioning via the api-version header to manage breaking changes. - [Webhooks](https://docs.augustus.com/v1/webhooks.md): Receive real-time notifications when events occur in your account. - [Authentication](https://docs.augustus.com/webhook-getting-started/authentication.md): When sending webhooks to your endpoints, Augustus will sign the request with a secret key. You can view and manage your secret key in the Augustus Dashboard. - [Introduction](https://docs.augustus.com/webhook-getting-started/introduction.md): Receive event notifications from Augustus through POST requests to your webhook endpoint. ## OpenAPI Specs - [openapi.documented](https://app.stainless.com/api/spec/documented/augustus/openapi.documented.yml) - [json](https://api.getivy.de/openapi/webhooks/json) - [openapi](https://docs.augustus.com/api-reference/openapi.json)