# Switch

> Stablecoin collection and settlement layer.

## Docs

- [Create beneficiary](https://docs.onswitch.xyz/api-reference/beneficiary/create-beneficiary.md): Create and save a beneficiary details for future payments.
- [Get beneficiaries](https://docs.onswitch.xyz/api-reference/beneficiary/get-beneficiaries.md): Returns paginated beneficiaries previously used as payment destination.
- [Get requirements](https://docs.onswitch.xyz/api-reference/beneficiary/get-requirements.md): Retrieve the required fields and validation rules for creating a beneficiary.
- [AML histories](https://docs.onswitch.xyz/api-reference/compliance/aml-histories.md): Returns paginated previous AML lookup history.
- [AML lookup](https://docs.onswitch.xyz/api-reference/compliance/aml-lookup.md): Screen an individual, business or crypto wallet against global compliance data.
- [Get payments](https://docs.onswitch.xyz/api-reference/history/get-payments.md): Returns paginated payments history.
- [Get summary](https://docs.onswitch.xyz/api-reference/history/get-summary.md): Returns aggregated payment statistics.
- [Get institution](https://docs.onswitch.xyz/api-reference/institution/get-institution.md): Retrieve institution-related data for the authenticated service. When `country` is provided, returns institutions (e.g. banks).
- [Lookup institution](https://docs.onswitch.xyz/api-reference/institution/lookup-institution.md): Resolve bank or payment institution details from country-specific identifiers.
- [Get assets](https://docs.onswitch.xyz/api-reference/miscellaneous/get-assets.md): Retrieve a list of all supported stablecoin assets.
- [Get coverage](https://docs.onswitch.xyz/api-reference/miscellaneous/get-coverage.md): Retrieve information about supported countries, currencies, and payment rails.
- [Get rates](https://docs.onswitch.xyz/api-reference/miscellaneous/get-rates.md): Retrieve exchange rates for all supported currencies.
- [Get quote](https://docs.onswitch.xyz/api-reference/offramp/get-quote.md): Get a real-time quote for an offramp transaction including exchange rate, settlement time, and payment rail information.
- [Get rate](https://docs.onswitch.xyz/api-reference/offramp/get-rate.md): Get the current exchange rate for an offramp transaction.
- [Initiate](https://docs.onswitch.xyz/api-reference/offramp/initiate.md): Initiate a stablecoin to local currency transaction.
- [Get quote](https://docs.onswitch.xyz/api-reference/onramp/get-quote.md): Get a real-time quote for an onramp transaction including exchange rate, settlement time, and payment rail information.
- [Get rate](https://docs.onswitch.xyz/api-reference/onramp/get-rate.md): Get the current exchange rate for an onramp transaction.
- [Initiate](https://docs.onswitch.xyz/api-reference/onramp/initiate.md): Initiate a local currency to stablecoin transaction.
- [Confirm deposit](https://docs.onswitch.xyz/api-reference/payment/confirm-deposit.md): Manually confirm a payment deposit.
- [Get status](https://docs.onswitch.xyz/api-reference/payment/get-status.md): Retrieve the current status and details of a payment.
- [Get quote](https://docs.onswitch.xyz/api-reference/swap/get-quote.md): Get a real-time quote for swapping between two stablecoin assets including exchange rate and fees.
- [Initiate](https://docs.onswitch.xyz/api-reference/swap/initiate.md): Initiate a swap transaction between two stablecoin assets.
- [Create wallet](https://docs.onswitch.xyz/api-reference/wallet/create-wallet.md): Create a new wallet with unified balance across multiple chains. One account, one balance, any chain.
- [Estimate fee](https://docs.onswitch.xyz/api-reference/wallet/estimate-fee.md): Estimate the network fee for transferring a specific asset from a wallet.
- [Export wallet](https://docs.onswitch.xyz/api-reference/wallet/export-wallet.md): Export wallet private key. Use with caution; the private key grants full control of the wallet.
- [Get balance](https://docs.onswitch.xyz/api-reference/wallet/get-balance.md): Get unified spendable wallet balance and breakdown by chain.
- [Get transactions](https://docs.onswitch.xyz/api-reference/wallet/get-transactions.md): List transactions for a wallet with optional pagination.
- [Get wallet](https://docs.onswitch.xyz/api-reference/wallet/get-wallet.md): Retrieve the details of an existing wallet
- [Get wallets](https://docs.onswitch.xyz/api-reference/wallet/get-wallets.md): Returns paginated stablecoin wallets
- [Lookup transaction](https://docs.onswitch.xyz/api-reference/wallet/lookup-transaction.md): Get details of a single transaction by its reference (UUID).
- [Rescue token](https://docs.onswitch.xyz/api-reference/wallet/rescue-token.md): Transfer a specific token (by contract address) from the wallet to a recipient address. Use to recover tokens that are not part of the unified balance (e.g. unsupported or airdropped tokens). Supports EVM and Solana token addresses.
- [Transfer funds](https://docs.onswitch.xyz/api-reference/wallet/transfer-funds.md): Send assets to any address across supported chains. No bridging, no swapping or gas tokens required.
- [Update wallet](https://docs.onswitch.xyz/api-reference/wallet/update-wallet.md): Update wallet details (e.g. callback URL for wallet notifications).
- [Get webhooks](https://docs.onswitch.xyz/api-reference/webhook/get-webhooks.md): Returns paginated webhooks history.
- [Resend webhook](https://docs.onswitch.xyz/api-reference/webhook/resend-webhook.md): Resend any webhook notification for a previous transactions.
- [Authentication](https://docs.onswitch.xyz/authentication.md): Authenticate the Switch REST API with your service key (x-service-key) for sandbox and production crypto payment and settlement requests.
- [Changelog](https://docs.onswitch.xyz/changelog.md): Release notes and updates for Switch.
- [Supported countries](https://docs.onswitch.xyz/countries.md): List of countries where you can settle stablecoin payouts in local currency using domestic payment rails. Switch also supports **SWIFT** for international wires into supported regions.
- [Developer fee](https://docs.onswitch.xyz/developer_fee.md): Take a percentage of each payment amount as a fee
- [Check status](https://docs.onswitch.xyz/guides/check-status.md): Look up the status of a payment by its reference.
- [Create stablecoin wallet](https://docs.onswitch.xyz/guides/create-wallet.md): Create a unified balance, non-custodial stablecoin wallet.
- [Get currencies](https://docs.onswitch.xyz/guides/get-currencies.md): List supported local currencies, channels and limits.
- [Get quote](https://docs.onswitch.xyz/guides/get-quote.md): Get a priced off-ramp quote with source and destination amounts
- [Get rate](https://docs.onswitch.xyz/guides/get-rate.md): Fetch rate for stablecoin to local currency conversion.
- [Get stablecoins](https://docs.onswitch.xyz/guides/get-stablecoins.md): List all supported stablecoins and metadata.
- [Stablecoin to CNY](https://docs.onswitch.xyz/guides/stablecoin-to-cny.md): Convert stablecoin (USDC, USDT) to Chinese Yuan.
- [Stablecoin to EUR](https://docs.onswitch.xyz/guides/stablecoin-to-eur.md): Convert stablecoin (USDC, USDT) to Euro.
- [Stablecoin to GBP](https://docs.onswitch.xyz/guides/stablecoin-to-gbp.md): Convert stablecoin (USDC, USDT) to British Pound.
- [Stablecoin to GHS](https://docs.onswitch.xyz/guides/stablecoin-to-ghs.md): Convert stablecoin (USDC, USDT) to Ghanaian Cedi.
- [Stablecoin to INR](https://docs.onswitch.xyz/guides/stablecoin-to-inr.md): Convert stablecoin (USDC, USDT) to Indian rupee.
- [Stablecoin to KES](https://docs.onswitch.xyz/guides/stablecoin-to-kes.md): Convert stablecoin (USDC, USDT) to Kenyan shilling.
- [Stablecoin to NGN](https://docs.onswitch.xyz/guides/stablecoin-to-ngn.md): Convert stablecoin (USDC, USDT) to Nigerian naira.
- [Swap stablecoins](https://docs.onswitch.xyz/guides/swap-stablecoins.md): Convert between supported stablecoins.
- [Introduction](https://docs.onswitch.xyz/introduction.md): Stablecoin collection and settlement layer.
- [Quickstart](https://docs.onswitch.xyz/quickstart.md): Authenticate with your service key, configure payout beneficiary, and complete your first stablecoin to local currency payout in minutes.
- [Payment reasons](https://docs.onswitch.xyz/reasons.md): Allowed payment reasons for initiating payouts or transfers.
- [Sandbox](https://docs.onswitch.xyz/sandbox.md): Use the sandbox environment to integrate Switch APIs safely. Transactions are simulated and carry no real-world value.
- [Supported stablecoins](https://docs.onswitch.xyz/stablecoins.md): List of supported USD-pegged stablecoins (USDC, USDT) and Naira-pegged stablecoin (CNGN) accross several networks including EVM chains, Solana (SVM), and Tron.
- [Stablecoin wallet](https://docs.onswitch.xyz/wallet.md): Non-custodial USDC and USDT wallets with one unified balance across supported chains—transfer anywhere without bridging or native gas.
- [Webhooks](https://docs.onswitch.xyz/webhook.md): Switch sends JSON **POST** notifications to a URL (**`callback_url`**) you provide when payment status changes or when a wallet receives or sends funds.

## OpenAPI Specs

- [openapi](https://docs.onswitch.xyz/openapi.json)