# Onramper Documentation

> Get the biggest onramp aggregator for your app instantly, onboard users globally across 190+ countries and reduce development time by 95%.

## Guides
- [Getting started 👋](https://docs.onramper.com/docs/getting-started.md): Get started with the world's leading fiat-to-crypto aggregator. You now have access to over 130 local payment methods and 20+ on-ramp providers at your fingertips! 🔥
- [Glossary 📢](https://docs.onramper.com/docs/glossary.md): Quick overview of frequently used words in our documentation that you may or may not know
- [Onboarding Guide 🙏](https://docs.onramper.com/docs/step-by-step-guide.md): We are on a mission to make it easy for any wallet, exchange and dApp to enable their end users to buy crypto with their preferred payment method be it a Visa card, PIX in Brazil, UPI in India or any other method.
- [Integration examples ⚡](https://docs.onramper.com/docs/integration-examples.md): Set-and-forget widget or finely tuned API integration? Whatever your needs, our flexible infrastructure's got you covered.
- [FAQ 🤔](https://docs.onramper.com/docs/faq-1.md): Below is a collection of the questions we get asked more frequently
- [Product overview](https://docs.onramper.com/docs/widget.md): The plug and play onramp product for your dApp
- [Widget integration options](https://docs.onramper.com/docs/integration-steps.md): How do you want your user experience to be?
- [Integrating in WebViews](https://docs.onramper.com/docs/integrating-in-webviews.md): Embedding the Onramper Widget in a WebView: Additional Configuration Steps.
- [Troubleshooting Google Pay in WebView Environments](https://docs.onramper.com/docs/troubleshooting-google-pay-in-webview-environments.md)
- [Customise the experience](https://docs.onramper.com/docs/customise-the-ux.md): Despite it being an Onramper widget, you have the power to modify the user flow
- [Supported widget parameters](https://docs.onramper.com/docs/supported-widget-parameters.md): Onramper provides a range of customization options for the widget, facilitated through parameters added as query strings to the widget integration URL.
- [Supported offramp parameters](https://docs.onramper.com/docs/supported-widget-parameters-offramp.md): Onramper provides a range of customization options for the widget, facilitated through parameters added as query strings to the widget integration URL.
- [Available offramp flows](https://docs.onramper.com/docs/offramp-process-flow.md): Learn about the Offramp process flows, including the differences between the QR code flow and the Wallet Initiation flow, key parameters, and system requirements for completing crypto transactions.
- [Supported swap parameters](https://docs.onramper.com/docs/supported-swap-parameters.md): Onramper lets you customize your swap experience by adding parameters to the widget URL.
- [White-labeled solution](https://docs.onramper.com/docs/white-labeling-solution.md): Our white-labeled solution allows clients to customize the branding of our platform with their own logos, ensuring a seamless brand experience for their users. This includes the ability to upload different logos for dark and light mode, which will be displayed across key parts of the user interface.
- [Theme the widget](https://docs.onramper.com/docs/theme-the-widget.md): You can tailor the widget to look exactly like your own brand
- [Optional - Set up webhooks](https://docs.onramper.com/docs/optional-set-up-webhooks.md): We utilize webhooks to provide real-time notifications when a transaction status changes.
- [Product Overview](https://docs.onramper.com/docs/product-overview.md)
- [Integration Steps](https://docs.onramper.com/docs/integration-steps-1.md)
- [Onramp ranking and recommendations](https://docs.onramper.com/docs/recommendations-and-onramp-ranking.md)
- [Optional: Webhook Setup](https://docs.onramper.com/docs/optional-webhook-setup.md)
- [Checkout V2](https://docs.onramper.com/docs/checkout-v2.md): Create a checkout session with the end user's IP hash and platform declared. Requires a Signature V2 request.
- [Feature overview](https://docs.onramper.com/docs/what-is-url-signing.md): Learn more about how to sign the URL when passing us the users' wallet address
- [Widget - Sign a URL](https://docs.onramper.com/docs/signing-widget-url.md)
- [API - Sign requests](https://docs.onramper.com/docs/sign-api-request.md)
- [Signature V2](https://docs.onramper.com/docs/signature-v2.md)
- [Feature overview](https://docs.onramper.com/docs/feature-overview.md): This section explains Signature V2, Onramper's request signing system for Widget and API integrations. Signatures ensure that sensitive data — like wallet addresses and amounts — cannot be altered or tampered with in transit.
- [Get set up: keys & onboarding](https://docs.onramper.com/docs/get-set-up-keys-onboarding.md)
- [Widget: Sign a URL (V2)](https://docs.onramper.com/docs/widget-sign-a-url-v2.md): When your widget URL includes wallet addresses or other sensitive parameters, you must sign the URL server-side with V2 and append the signature parameters. If the signature is invalid, missing, or expired, the transaction is restricted at checkout.
- [API: Sign requests (V2)](https://docs.onramper.com/docs/api-sign-requests-v2.md): A V2 API signature covers the entire request envelope — method, path, query, signed headers, and body hash — not just the URL. Include the signature in request headers.
- [Migrating from V1 to V2](https://docs.onramper.com/docs/migrating-from-v1-to-v2.md)
- [Error codes & troubleshooting](https://docs.onramper.com/docs/error-codes-troubleshooting.md): You will receive these error codes when reaching api.onramper.com (and the corresponding stg) with poorly built signatures.  ###
- [Sandbox Testing Guide](https://docs.onramper.com/docs/testing-overview.md): Below is an overview of the testing capabilities we provide as part of the Onramper integration experience
- [Provider Testing Credentials](https://docs.onramper.com/docs/provider-sandbox-guide.md): Below is a step by step guide that will help you test transactions in a sandbox flow environment
- [On/offramps ](https://docs.onramper.com/docs/onramp-providers.md): List of all supported on and offramps
- [Feature support (per ramp)](https://docs.onramper.com/docs/feature-support-per-onramp.md)
- [Payment methods](https://docs.onramper.com/docs/supported-payment-methods.md)
- [Crypto assets](https://docs.onramper.com/docs/crypto-asset-support.md): A list of supported cryptocurrencies.
- [Fiat currencies](https://docs.onramper.com/docs/fiat-currency-support.md): A list of supported fiat currencies.
- [Network support](https://docs.onramper.com/docs/network-support.md): A list of supported blockchain networks
- [Widget - swaps](https://docs.onramper.com/docs/widget-swaps.md)
- [MCP](https://docs.onramper.com/docs/mcp.md)

## API Reference
- [Get Currencies](https://docs.onramper.com/reference/get_supported.md): Retruns a complete list of supported fiat and cryptocurrency options, based on the specified transaction type and country.  🛠️ Please Use [https://api-stg.onramper.com/](https://api-stg.onramper.com/) For Test Environments
- [Get Payments](https://docs.onramper.com/reference/get_supported-payment-types.md): Retruns the payment methods available for a given transaction type, whether the payment is recurring or not. The response will provide a list of supported payment methods for both fiat and cryptocurrency transactions.  **Note:**  This endpoint returns results for (type, country) combinations.  For a (type, country) there are multiple available (source, destination) currency pairs. This endpoint does **not** guarantee that all payment methods returned will be valid for the (source, destination) pairs available in that (type, country). Rather payment methods will be returned if a payment method is available for **at least one** (source, destination) pair in that (type, country).  **Recommended usage:**  Call this endpoint to get the available payment methods for the (type, country) combination.  Then filter the payment methods by calling the [Payment Type Source Destination endpoint](https://docs.onramper.com/reference/get_supported-payment-types-source#/) to filter by (type, source, destination).  🛠️ Please Use [https://api-stg.onramper.com/](https://api-stg.onramper.com/) For Test Environments
- [Get Payments by Source and Destination Currency](https://docs.onramper.com/reference/get_supported-payment-types-source.md): Returns supported payment methods based on the specified source currency, transaction type, recurrence status, destination currency and country.
- [Get Defaults](https://docs.onramper.com/reference/get_supported-defaults-all.md): Returns a comprehensive list of default fiat currencies, cryptocurrencies, fiat amounts, and payment methods tailored to each country. A recommended option is automatically selected based on the country from which the request originates.  🛠️ Please Use [https://api-stg.onramper.com/](https://api-stg.onramper.com/) For Test Environments
- [Get Assets](https://docs.onramper.com/reference/get_supported-assets.md): Returns assets based on the provided source currency. For buy transactions, it will return supported cryptocurrencies and payment methods. For sell transactions, it will return supported fiat currencies and payment methods.  🛠️ Please Use [https://api-stg.onramper.com/](https://api-stg.onramper.com/) For Test Environments
- [Get Onramps](https://docs.onramper.com/reference/get_supported-onramps.md): Returns supported onramps for a specified transaction type, source currency, destination currency, and country.  🛠️ Please Use [https://api-stg.onramper.com/](https://api-stg.onramper.com/) For Test Environments
- [Get Onramp Metadata](https://docs.onramper.com/reference/get_supported-onramps-all.md): Retruns metadata for all supported onramps available for a specified transaction type.  🛠️ Please Use [https://api-stg.onramper.com/](https://api-stg.onramper.com/) For Test Environments
- [[Deprecated] Get Crypto Currencies by Fiat](https://docs.onramper.com/reference/get_supported-crypto.md): ⚠️ - This API is deprecated and wll be subject to removal in the upcoming future. Please use the 'Get Assets' (GET /supported/assets) API instead.  Retruns cryptocurrencies that can be purchased with a specified fiat currency for a given country.  🛠️ Please Use [https://api-stg.onramper.com/](https://api-stg.onramper.com/) For Test Environments
- [Get Buy Quotes](https://docs.onramper.com/reference/get_quotes-fiat-crypto.md): Generates price quotes from all available providers based on the provided input parameters.  🛠️ Please Use [https://api-stg.onramper.com/](https://api-stg.onramper.com/) For Test Environments
- [Get Sell Quotes](https://docs.onramper.com/reference/get_quotes-crypto-fiat.md): Generates price quotes from all available providers based on the provided input parameters.  🛠️ Please Use [https://api-stg.onramper.com/](https://api-stg.onramper.com/) For Test Environments
- [List Transactions](https://docs.onramper.com/reference/get_transactions.md): Retruns a list of transactions associated with your account. You can filter the results based on date range and specify transaction IDs to get detailed transaction history.  🛠️ Please Use [https://api-stg.onramper.com/](https://api-stg.onramper.com/) For Test Environments
- [Initiate a Transaction](https://docs.onramper.com/reference/post_checkout-intent.md): > 🚧 **This endpoint will be deprecated soon.** Use [Initiate a Transaction (V2)](/reference/post_checkout-v2-intent) for new integrations.  Initiates a transaction and returns relevant data, including redirect type and URL. These details can be found within the '`transactionInformation`' object in the response.  🛠️ Please Use [https://api-stg.onramper.com/](https://api-stg.onramper.com/) For Test Environments
- [Transaction Confirmation - Sell Flow](https://docs.onramper.com/reference/post_transactions-confirm-type.md): Used to confirm a transaction in the selling flow. By specifying the transaction type.  🛠️ Please Use [https://api-stg.onramper.com/](https://api-stg.onramper.com/) For Test Environments
- [Get Transaction](https://docs.onramper.com/reference/get_transactions-transactionid.md): Returns transaction details for the specified transaction ID. The webhook secret is required for authentication.  🛠️ Please Use [https://api-stg.onramper.com/](https://api-stg.onramper.com/) For Test Environments
- [Initiate a Transaction (V2)](https://docs.onramper.com/reference/post_checkout-v2-intent.md): Creates a checkout session bound to the end user's IP and returns the URL to redirect them to.  **This endpoint requires a Signature V2 request.** Sign every call with your Ed25519 key and send `x-onramper-signature`, `x-onramper-timestamp` and `x-onramper-nonce`. There is no API-key-only mode: an unsigned or invalid request returns 401. See [API: Sign requests (V2)](https://docs.onramper.com/docs/api-sign-requests-v2).  The body is the same as `POST /checkout/intent`, plus `endUserIpHash` (required) and `platform`. Both are covered by the signature, so build them before you sign. `clientIpHash` remains accepted as a deprecated alias.  Step-by-step integration guide: [Checkout V2](https://docs.onramper.com/docs/checkout-v2). Widget integrations do not call this endpoint. They pass `endUserIpHash` as a signed URL parameter instead: [Widget: Sign a URL (V2)](https://docs.onramper.com/docs/widget-sign-a-url-v2#bind-the-session-to-the-end-users-ip).  Redirect the browser to `redirectUrl` exactly as returned. It carries a one-time resume token, so treat it as a credential. Each session is single-use and expires 10 minutes after intent.  🛠️ Please Use [https://api-stg.onramper.com/](https://api-stg.onramper.com/) For Test Environments