# Ivy Docs

## Docs

- [List Banks](https://docs.getivy.de/api-reference/bank/list-banks.md): Get a list of banks. You can filter by group, capability and market.
- [Retrieve a Bank](https://docs.getivy.de/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.getivy.de/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.getivy.de/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.getivy.de/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.getivy.de/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.getivy.de/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.getivy.de/api-reference/checkout/retrieve-a-checkout-session.md): Retrieve a Checkout Session and its details by Ivy id.
- [Create a Customer](https://docs.getivy.de/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.getivy.de/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.getivy.de/api-reference/customer/retrieve-a-customer.md): Retrieve a Customer Object by its id.
- [Search Customers](https://docs.getivy.de/api-reference/customer/search-customers.md): Search for customers you have previously created using filters, e.g. by email.
- [Update a Customer](https://docs.getivy.de/api-reference/customer/update-a-customer.md): Update the Customer details
- [Retrieve a deposit](https://docs.getivy.de/api-reference/deposit/retrieve-a-deposit.md): Retrieves a deposit by its ID.
- [Execute FX](https://docs.getivy.de/api-reference/fx/execute-fx.md): Execute a standalone foreign exchange transaction.
- [Retrieve Exchange Rate](https://docs.getivy.de/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.getivy.de/api-reference/fx/retrieve-fx-details.md): Retrieve the details of a past fx transfer using the fxId.
- [Create an Order](https://docs.getivy.de/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.getivy.de/api-reference/order/expire-an-order.md): Manually expire an order before its natural expiration time.
- [Retrieve an Order](https://docs.getivy.de/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.getivy.de/api-reference/payout/create-a-payout.md): Create a payout for a merchant.
- [List payouts](https://docs.getivy.de/api-reference/payout/list-payouts.md): List payouts for a merchant.
- [Payout available balances](https://docs.getivy.de/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.getivy.de/api-reference/payout/retrieve-a-payout.md): Retrieve a payout object by id.
- [Create a refund](https://docs.getivy.de/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.getivy.de/api-reference/refund/retrieve-a-refund.md): Returns refund details and Id of refunded order.
- [Create a return](https://docs.getivy.de/api-reference/return/create-a-return.md): Creates a return for a deposit.
- [Retrieve a return](https://docs.getivy.de/api-reference/return/retrieve-a-return.md): Retrieves a return by its ID.
- [Create a Subaccount](https://docs.getivy.de/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.getivy.de/api-reference/subaccount/retrieve-a-subaccount.md): Retrieve a Subaccount by id.
- [List transactions](https://docs.getivy.de/api-reference/transactions/list-transactions.md): Retrieve a paginated list of transactions for the specified time period
- [Verify payee bank account](https://docs.getivy.de/api-reference/vop/verify-payee-bank-account.md): Verify that the provided account holder name matches the bank account details.
- [Create a webhook subscription](https://docs.getivy.de/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.getivy.de/api-reference/webhook-subscription/delete-a-webhook-subscription.md): Deletes a webhook subscription.
- [List webhook subscriptions](https://docs.getivy.de/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.getivy.de/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.getivy.de/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.
- [Trigger a specific webhook](https://docs.getivy.de/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.getivy.de/api-reference/webhookeventexamples/checkout_session_completed.md): A checkout session has been completed
- [checkout_session_created](https://docs.getivy.de/api-reference/webhookeventexamples/checkout_session_created.md): A checkout session has been created
- [checkout_session_expired](https://docs.getivy.de/api-reference/webhookeventexamples/checkout_session_expired.md): A checkout session has expired
- [checkout_session_updated](https://docs.getivy.de/api-reference/webhookeventexamples/checkout_session_updated.md): A checkout session has been updated
- [data_session_completed](https://docs.getivy.de/api-reference/webhookeventexamples/data_session_completed.md): A data session has been completed
- [deposit.received](https://docs.getivy.de/api-reference/webhookeventexamples/depositreceived.md): A deposit has been received
- [fx.failed](https://docs.getivy.de/api-reference/webhookeventexamples/fxfailed.md): An FX has failed
- [fx.initiated](https://docs.getivy.de/api-reference/webhookeventexamples/fxinitiated.md): An FX has been initiated
- [fx.succeeded](https://docs.getivy.de/api-reference/webhookeventexamples/fxsucceeded.md): An FX has succeeded
- [merchant_updated](https://docs.getivy.de/api-reference/webhookeventexamples/merchant_updated.md): Your merchant account has been updated
- [order_created](https://docs.getivy.de/api-reference/webhookeventexamples/order_created.md): An order has been created
- [order_updated](https://docs.getivy.de/api-reference/webhookeventexamples/order_updated.md): An order has been updated
- [payout_created](https://docs.getivy.de/api-reference/webhookeventexamples/payout_created.md): A payout has been created
- [payout_report_requested](https://docs.getivy.de/api-reference/webhookeventexamples/payout_report_requested.md): A payout report has been requested
- [payout_updated](https://docs.getivy.de/api-reference/webhookeventexamples/payout_updated.md): A payout has been updated
- [payout.failed](https://docs.getivy.de/api-reference/webhookeventexamples/payoutfailed.md): A payout has failed
- [payout.initiated](https://docs.getivy.de/api-reference/webhookeventexamples/payoutinitiated.md): A payout has been initiated
- [payout.paid](https://docs.getivy.de/api-reference/webhookeventexamples/payoutpaid.md): A payout has been paid
- [refund_failed](https://docs.getivy.de/api-reference/webhookeventexamples/refund_failed.md): A refund initiated with `/merchant/payment/refund` failed
- [refund_succeeded](https://docs.getivy.de/api-reference/webhookeventexamples/refund_succeeded.md): A refund initiated with `/merchant/payment/refund` succeeded
- [refund.failed](https://docs.getivy.de/api-reference/webhookeventexamples/refundfailed.md): A refund initiated with `/refund/create` failed
- [refund.initiated](https://docs.getivy.de/api-reference/webhookeventexamples/refundinitiated.md): A refund initiated with `/refund/create`
- [refund.succeeded](https://docs.getivy.de/api-reference/webhookeventexamples/refundsucceeded.md): A refund initiated with `/refund/create` succeeded
- [return.failed](https://docs.getivy.de/api-reference/webhookeventexamples/returnfailed.md): A return has failed
- [return.initiated](https://docs.getivy.de/api-reference/webhookeventexamples/returninitiated.md): A return has been initiated
- [return.returned](https://docs.getivy.de/api-reference/webhookeventexamples/returnreturned.md): A return has been returned
- [return.succeeded](https://docs.getivy.de/api-reference/webhookeventexamples/returnsucceeded.md): A return has succeeded
- [Test](https://docs.getivy.de/api-reference/webhookeventexamples/test.md): Can be triggered with `/webhook-subscription/ping` to test the integration
- [user_payout.failed](https://docs.getivy.de/api-reference/webhookeventexamples/user_payoutfailed.md): A customer payout has failed
- [user_payout.initiated](https://docs.getivy.de/api-reference/webhookeventexamples/user_payoutinitiated.md): A customer payout has been initiated
- [user_payout.paid](https://docs.getivy.de/api-reference/webhookeventexamples/user_payoutpaid.md): A customer payout has been paid
- [Offramp](https://docs.getivy.de/docs/On-Offramp/offramp.md): Deposit crypto funds to your Ivy wallet and offramp to fiat to fund your fiat operations
- [Onramp](https://docs.getivy.de/docs/On-Offramp/onramp.md): Onramp fiat funds to your Ivy wallet to fund your crypto operations
- [Balances](https://docs.getivy.de/docs/accounts/balances.md): Hold fiat and stablecoin funds in your Ivy account
- [FX](https://docs.getivy.de/docs/accounts/fx.md): Use Standalone FX to swap any of your currency balances regardless of stablecoin or fiat.
- [Overview](https://docs.getivy.de/docs/accounts/overview.md): Create Accounts and Balances with Ivy
- [Settlement Reporting](https://docs.getivy.de/docs/accounts/payout-report.md): Get a report of all payouts and settlements made to your account
- [Transaction Reporting](https://docs.getivy.de/docs/accounts/transaction-list.md): Retrieve transactions for your accounts in JSON format via API.
- [Virtual Accounts (Coming Soon)](https://docs.getivy.de/docs/accounts/virtual-account-api-coming-soon.md): Virtual account API is coming soon.
- [Wallet](https://docs.getivy.de/docs/accounts/wallet.md): How to enable wallets and find wallet information for stablecoin payments
- [Core Concepts](https://docs.getivy.de/docs/basics/concepts.md): Understand the main building blocks of the Ivy API: Payin, Payout, and Account.
- [Dashboard](https://docs.getivy.de/docs/basics/dashboard.md): Learn the basics of the Ivy Dashboard.
- [Welcome to Ivy](https://docs.getivy.de/docs/basics/introduction.md): About Ivy, our platform, and how to get up and running fast.
- [Test Mode](https://docs.getivy.de/docs/basics/test-mode-sandbox.md): Use test mode to test your Ivy integration before going live with payments.
- [Deposits (Fiat + Crypto)](https://docs.getivy.de/docs/payin/deposits.md): Receive fiat or crypto funds into your Ivy account via IBAN or Wallet, with full control over unmatched transactions.
- [Ecommerce](https://docs.getivy.de/docs/payin/instant-bank-transfer/best-practices/ecommerce.md): Best practices on how to integrate Ivy payments into your e-commerce checkout.
- [Financial Services](https://docs.getivy.de/docs/payin/instant-bank-transfer/best-practices/financial-services.md): Best practices on integrating Ivy deposits into your financial service or crypto app.
- [Financial Services](https://docs.getivy.de/docs/payin/instant-bank-transfer/best-practices/withdrawals.md): Best practices on integrating Ivy withdrawals into your financial service or crypto app.
- [Failure Reasons](https://docs.getivy.de/docs/payin/instant-bank-transfer/failure-reasons.md): Understand the main failure reasons for instant bank transfers and how to handle them in your integration.
- [Client Integration](https://docs.getivy.de/docs/payin/instant-bank-transfer/iframe.md): Optimise your implementation of Ivy's Checkout for the best user experience for any platform
- [Integration Flow](https://docs.getivy.de/docs/payin/instant-bank-transfer/payment-integration.md): Everything you need to let customers pay in money with instant bank transfers
- [Status Flow](https://docs.getivy.de/docs/payin/instant-bank-transfer/payment-status.md): Understand the lifecycle of an instant bank transfer and manual bank transfer.
- [Remember Me](https://docs.getivy.de/docs/payin/instant-bank-transfer/remember-me.md): Boost conversion by simplifying your customers' checkout experience
- [Test Your Integration](https://docs.getivy.de/docs/payin/instant-bank-transfer/test-your-integration.md)
- [UX Best Practice](https://docs.getivy.de/docs/payin/mbt/best-practices.md): UX best practice for integrating Manual Bank Transfer into your checkout.
- [Integration Flow](https://docs.getivy.de/docs/payin/mbt/mbt.md): Allow your customers to transfer money from their bank account manually.
- [Overview](https://docs.getivy.de/docs/payin/payin-intro.md): Introduction to payin flows and concepts.
- [Overview](https://docs.getivy.de/docs/payout/overview.md): Introduction to payout flows and concepts.
- [Payouts](https://docs.getivy.de/docs/payout/payout.md): Send money anywhere — customers, partners, suppliers, or external accounts.
- [Refunds](https://docs.getivy.de/docs/payout/refunds-payouts.md): Refund all or part of an order quickly and reliably.
- [Settlements](https://docs.getivy.de/docs/payout/settlements.md): How to settle your Ivy balance to an external account
- [Test Your Integration](https://docs.getivy.de/docs/payout/test-your-integration.md)
- [Versioning](https://docs.getivy.de/reference/api-versions.md): Learn how to specify which Ivy API version to use whenever you make a request to the Ivy API.
- [Authentication](https://docs.getivy.de/reference/authentication.md): The Ivy API uses API Keys to authenticate requests. You can view and manage your API Key in the Ivy Dashboard.
- [Errors](https://docs.getivy.de/reference/errors.md): Ivy's API utilizes standard HTTP response codes to provide information about the success or failure of API requests.
- [Idempotency](https://docs.getivy.de/reference/idempotency.md): Use idempotency keys to safely retry POST requests without creating duplicate operations.
- [Introduction](https://docs.getivy.de/reference/introduction.md)
- [Metadata](https://docs.getivy.de/reference/metadata.md): Most updatable Ivy objects have a Metadata parameter. You can use this parameter to attach arbitrary key-value data to these Ivy objects.
- [Authentication](https://docs.getivy.de/webhook-getting-started/authentication.md): When sending webhooks to your endpoints, Ivy will sign the request with a secret key. You can view and manage your secret key in the Ivy Dashboard.
- [Introduction](https://docs.getivy.de/webhook-getting-started/introduction.md): Receive event notifications from Ivy through POST requests to your webhook endpoint.

## OpenAPI Specs

- [json](https://api.getivy.de/openapi/webhooks/json)
- [openapi.documented](https://app.stainless.com/api/spec/documented/augustus/openapi.documented.yml)
- [openapi](https://docs.getivy.de/api-reference/openapi.json)