> For the complete documentation index, see [llms.txt](https://docs.omypayments.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.omypayments.com/api.md).

# API

- [Overview](https://docs.omypayments.com/api/overview.md)
- [Authentication](https://docs.omypayments.com/api/authentication.md)
- [API Endpoints](https://docs.omypayments.com/api/api-endpoints.md)
- [Mass Payouts](https://docs.omypayments.com/api/api-endpoints/mass-payouts.md)
- [Create a payout (container)](https://docs.omypayments.com/api/api-endpoints/mass-payouts/create-a-payout-container.md)
- [Rename a payout](https://docs.omypayments.com/api/api-endpoints/mass-payouts/rename-a-payout.md)
- [Delete a payout](https://docs.omypayments.com/api/api-endpoints/mass-payouts/delete-a-payout.md)
- [Add a recipient (target)](https://docs.omypayments.com/api/api-endpoints/mass-payouts/add-a-recipient-target.md)
- [Update a recipient](https://docs.omypayments.com/api/api-endpoints/mass-payouts/update-a-recipient.md)
- [Delete a recipient](https://docs.omypayments.com/api/api-endpoints/mass-payouts/delete-a-recipient.md)
- [Start a payout run (create task)](https://docs.omypayments.com/api/api-endpoints/mass-payouts/start-a-payout-run-create-task.md)
- [Error format](https://docs.omypayments.com/api/api-endpoints/mass-payouts/error-format.md)
- [Swaps](https://docs.omypayments.com/api/api-endpoints/swaps.md): Estimate and execute swaps between two of your merchant assets (a different token and/or network). This page documents the HTTP endpoints you’ll call from your backend. Authentication and the error-en
- [Estimate a swap](https://docs.omypayments.com/api/api-endpoints/swaps/estimate-a-swap.md): Get a quote for swapping one merchant asset into another. The estimate is held for \*\*30 minutes\*\* and is single-use — creating a swap from it consumes the quote.
- [Create a swap](https://docs.omypayments.com/api/api-endpoints/swaps/create-a-swap.md): Execute a swap from a previously obtained estimate. The source amount is immediately reserved from the asset’s available balance, and the swap starts processing asynchronously. Track its progress with
- [Get a swap](https://docs.omypayments.com/api/api-endpoints/swaps/get-a-swap.md): Return the current state of a swap by its ID. Poll this endpoint to track progress, or rely on Callbacks to be notified of status changes.
- [Error format](https://docs.omypayments.com/api/api-endpoints/swaps/error-format.md): Swap endpoints share the public API error envelopes. The per-endpoint validation messages are listed on each endpoint page.
- [Withdrawals](https://docs.omypayments.com/api/api-endpoints/withdrawals.md): Send funds from your merchant assets to on-chain addresses and track each withdrawal to completion. This page documents the HTTP endpoints you’ll call from your backend. Authentication and the error-e
- [Withdraw an asset](https://docs.omypayments.com/api/api-endpoints/withdrawals/withdraw-an-asset.md): Send funds from one of your merchant assets to an on-chain address. The requested amount (plus the system fee, see payer below) is immediately reserved from the asset’s available balance, and the with
- [Get a withdrawal](https://docs.omypayments.com/api/api-endpoints/withdrawals/get-a-withdrawal.md): Return the current state of a withdrawal by its ID. Poll this endpoint to track progress, or rely on callbacks to be notified of status changes.
- [List withdrawals](https://docs.omypayments.com/api/api-endpoints/withdrawals/list-withdrawals.md): Return a paginated list of your merchant’s withdrawals, newest first. Use it to reconcile withdrawals or to poll recent activity; for a single withdrawal use Get a withdrawal.
- [Get Merchant Assets](https://docs.omypayments.com/api/api-endpoints/get-merchant-assets.md)
- [Get Merchant Asset Data](https://docs.omypayments.com/api/api-endpoints/get-merchant-asset-data.md)
- [Create Invoice](https://docs.omypayments.com/api/api-endpoints/create-invoice.md)
- [Create Invoice by Crypto](https://docs.omypayments.com/api/api-endpoints/create-invoice-by-crypto.md)
- [Get Invoice Data](https://docs.omypayments.com/api/api-endpoints/get-invoice-data.md)
- [Callbacks](https://docs.omypayments.com/api/callbacks.md): OmyPayments notifies your backend by calling your \*\*Callback URL\*\* whenever an entity changes status. Set the Callback URL in your account settings.
- [Invoice Statuses](https://docs.omypayments.com/api/invoice-statuses.md)
- [Common issues](https://docs.omypayments.com/api/common-issues.md)