# MoonPay Documentation

## Guides
- [Advantages of our products](https://dev.moonpay.com/docs/advantages-of-our-products.md): ⭐️ All in one infrastructure for your Web3 needs
- [Integration examples](https://dev.moonpay.com/docs/integration-examples.md): The videos below showcase excellent examples of MoonPay integrations, categorized by platform.
- [Sandbox testing guide](https://dev.moonpay.com/docs/faq-sandbox-testing.md): 🏖️ Sandbox environment for all your development needs
- [FAQ](https://dev.moonpay.com/docs/faqs.md)
- [Overview](https://dev.moonpay.com/docs/on-ramp-overview.md)
- [Architecture](https://dev.moonpay.com/docs/on-ramp-architecture.md)
- [Quickstart](https://dev.moonpay.com/docs/on-ramp-quickstart.md)
- [Integration design guide](https://dev.moonpay.com/docs/design-your-integration.md): Design requirements for your MoonPay integration
- [URL Integration](https://dev.moonpay.com/docs/on-ramp-integrate-using-simple-url.md): Our simple URL based Integration
- [SDK Integration](https://dev.moonpay.com/docs/on-ramp-integrate-using-sdk.md)
- [Web SDK](https://dev.moonpay.com/docs/on-ramp-web-sdk.md): 🖥️ Installation guide for our Web SDK
- [React SDK](https://dev.moonpay.com/docs/on-ramp-react-sdk.md): 🖥️ Installation guide for our Web SDK in React
- [Node.js SDK](https://dev.moonpay.com/docs/on-ramp-node-sdk.md): For Node-based backends and actions that require your secret key
- [React Native SDK (Mobile)](https://dev.moonpay.com/docs/on-ramp-react-native-sdk.md): 📱 Installation guide for our React Native SDK
- [SDK Ramp Events](https://dev.moonpay.com/docs/on-ramp-sdk-events-details.md): Widget events in the SDK communication layer
- [SDK Event Properties](https://dev.moonpay.com/docs/on-ramp-sdk-events-properties.md): Properties for widget SDK events
- [On-ramp widget parameters](https://dev.moonpay.com/docs/ramps-sdk-buy-params.md)
- [Widget theming](https://dev.moonpay.com/docs/on-ramp-personalize-appearance.md)
- [URL signing](https://dev.moonpay.com/docs/on-ramp-enhance-security-using-signed-urls.md): Protecting your sensitive data
- [Mobile payments](https://dev.moonpay.com/docs/faq-mobile-payments.md): 📱 Requirements for using Apple Pay and Google Pay
- [FAQ](https://dev.moonpay.com/docs/on-ramp-faq.md)
- [Overview](https://dev.moonpay.com/docs/off-ramp-overview.md)
- [Architecture](https://dev.moonpay.com/docs/off-ramp-architecture.md)
- [Quickstart](https://dev.moonpay.com/docs/off-ramp-quickstart.md)
- [Integration design guide](https://dev.moonpay.com/docs/design-your-off-ramp-integration.md): Design requirements for your MoonPay integration
- [URL Integration](https://dev.moonpay.com/docs/off-ramp-how-to-integrate-using-simple-url.md): Our simple URL based Integration
- [SDK Integration](https://dev.moonpay.com/docs/off-ramp-how-to-integrate-using-sdk.md)
- [Web SDK](https://dev.moonpay.com/docs/off-ramp-web-sdk.md): 🖥️ Installation guide for our Web SDK
- [React SDK](https://dev.moonpay.com/docs/off-ramp-react-sdk.md): 🖥️ Installation guide for our Web SDK in React
- [Node.js SDK](https://dev.moonpay.com/docs/off-ramp-node-sdk.md): For Node-based backends and actions that require your secret key
- [React Native SDK (Mobile)](https://dev.moonpay.com/docs/off-ramp-react-native-sdk.md): 📱 Installation guide for our React Native SDK
- [SDK Ramp Events](https://dev.moonpay.com/docs/off-ramp-sdk-events-details.md): Widget events in the SDK communication layer
- [SDK Event Properties](https://dev.moonpay.com/docs/off-ramp-sdk-events-properties.md): Properties for widget SDK events
- [Requote Webhooks](https://dev.moonpay.com/docs/requote-webhooks.md): Use Requote webhooks to improve user experience and increase conversion on your off-ramp
- [Off-ramp widget parameters](https://dev.moonpay.com/docs/ramps-sdk-sell-params.md)
- [Widget theming](https://dev.moonpay.com/docs/customize-the-widgets-appearance.md)
- [URL signing](https://dev.moonpay.com/docs/off-ramp-enhance-security-using-signed-urls.md): ✍️ Protecting your sensitive data
- [FAQ](https://dev.moonpay.com/docs/off-ramp-faq.md)
- [Overview](https://dev.moonpay.com/docs/virtual-accounts-product-overview.md): MoonPay Virtual Accounts, powered by Iron
- [Prerequisites](https://dev.moonpay.com/docs/get-started.md): Getting set up to use Virtual Accounts
- [Integration Guide](https://dev.moonpay.com/docs/virtual-accounts-integration-guide.md): A step by step guide on how to enable Virtual Accounts in your app
- [User Journeys](https://dev.moonpay.com/docs/virtual-accounts-user-journeys.md): Illustrative journeys to help you design your experience and integration.
- [On Ramps](https://dev.moonpay.com/docs/api-reference.md)
- [Blockchains & Cryptocurrencies](https://dev.moonpay.com/docs/blockchains.md)
- [Payment Methods](https://dev.moonpay.com/docs/payment-methods.md)
- [Country Coverage](https://dev.moonpay.com/docs/country-coverage.md)
- [Overview](https://dev.moonpay.com/docs/top-up-overview.md)
- [Quickstart](https://dev.moonpay.com/docs/quickstart.md)
- [Configure the Top-up user journey](https://dev.moonpay.com/docs/configure-the-top-up-user-journey.md): Query parameters used to customize the user journey
- [Integrations (SDKs)](https://dev.moonpay.com/docs/integrations-sdks.md)
- [Web SDK](https://dev.moonpay.com/docs/web-sdk.md)
- [Node.js SDK](https://dev.moonpay.com/docs/nodejs-sdk.md): For Node-based backends and actions that require your secret key
- [React SDK](https://dev.moonpay.com/docs/react-sdk.md): 🖥️ Installation guide for our Web SDK in React

## API Reference
- [List Buy transactions](https://dev.moonpay.com/reference/get_v1-transactions.md): Returns an array of successful Buy transactions which fulfill criteria supplied in the query parameters. Each entry in the array is a separate transaction object. Transactions will be listed from newest to oldest.
- [Get Customer Limits](https://dev.moonpay.com/reference/get_v1-customers-customerid.md): Returns basic limits information about a customer based on their MoonPay ID. For you to be able to retrieve a customer, they must have at least one session initiated with your `Api-Key`.
- [Get Customer Limits by external ID](https://dev.moonpay.com/reference/get_v1-customers-ext-customerid.md): Returns basic limits information about a customer based on their external customer ID. For you to be able to retrieve a customer, they must have at least one session initiated with your `API-Key`. Please note that this endpoint returns an array of objects because we cannot ensure the uniqueness of the external customer ID.
- [List Sell transactions](https://dev.moonpay.com/reference/get_v3-sell-transactions.md): Returns an array of successful Sell transactions which fulfill criteria supplied in the query parameters. Each entry in the array is a separate transaction object. Transactions will be listed from newest to oldest. This call will return an error if `customerId` is not supplied in the query parameters.
- [Cancel Sell transaction](https://dev.moonpay.com/reference/delete_v3-sell-transactions-transactionid.md): Cancels a sell transaction. This endpoint will return HTTP status <span class="value">204 No Content</span> if the sell transaction was successfully canceled. If sell transaction could not be canceled (e.g. because it has already been completed) it will return HTTP status <span class="value">409 Conflict</span>.
- [Cancel Sell transaction by external ID](https://dev.moonpay.com/reference/delete_v3-sell-transactions-ext-transactionid.md): Cancels a sell transaction based on their external transaction ID. This endpoint will return HTTP status <span class="value">204 No Content</span> if the sell transaction was successfully canceled. If sell transaction could not be canceled (e.g. because it has already been completed) it will return HTTP status <span class="value">409 Conflict</span>.
- [My Account Details](https://dev.moonpay.com/reference/getaccount-1.md): Get your account details, including the verification status and the current fees.  Returns the account associated with the provided `apiKey`.
- [Get Crypto Currency limits](https://dev.moonpay.com/reference/getcurrencylimits-1.md): Returns an object containing minimum and maximum buy amounts including or excluding fees for base and quote currencies.  It takes into account the payment method if it's provided, **otherwise it defaults to the payment method with the lowest fees.**
- [Get Crypto network fees](https://dev.moonpay.com/reference/getnetworkfees-1.md): Returns a set of key-value pairs representing the current network fees of cryptocurrencies against fiat currencies.  Supply the codes of the crypto and fiat currencies you are interested in, and MoonPay will return the relevant network fees.
- [Get Real-time Buy quote](https://dev.moonpay.com/reference/getbuyquote-1.md): Get detailed real-time quote based on the provided currency code, base amount, your extra fee percentage, payment method, and the inclusion of the fees.
- [Get Buy transaction](https://dev.moonpay.com/reference/getbuytransaction-1.md): Retrieve a transaction by id. This call will return an error if no transaction with the supplied identifier exists.
- [Get Buy transaction by External identifier](https://dev.moonpay.com/reference/getbuytransactionbyexternalid-1.md): Retrieve a transaction by its externalTransactionId. This is the identifier you assigned the transaction when creating it. This endpoint returns an array of objects because we cannot ensure the uniqueness of externalTransactionId.
- [Get Sell quote](https://dev.moonpay.com/reference/getsellquote-1.md): Returns a set of key-value pairs representing a real-time sell quote for a currency. Supply the currency code, the base amount, your extra fee percentage, the payment method and whether the base amount is inclusive of fees, and MoonPay will return a detailed sell quote.
- [Get Sell transaction](https://dev.moonpay.com/reference/getselltransaction-1.md): Retrieve a sell transaction by id. This call will return an error if no sell transaction with the supplied identifier exists.
- [Get Sell transaction by External identifier](https://dev.moonpay.com/reference/getselltransactionbyexternalid-1.md): Retrieve a transaction by its externalTransactionId. This is the identifier you assigned the transaction when creating it. This endpoint returns an array of objects because we cannot ensure the uniqueness of externalTransactionId.
- [List supported countries](https://dev.moonpay.com/reference/getcountries-2.md): Returns the list of countries currently supported by MoonPay.
- [List available payment methods and their capabilities/limits](https://dev.moonpay.com/reference/get_payments-v1-payment-method-config.md)
- [List supported currencies](https://dev.moonpay.com/reference/getcurrencies.md): Returns the list of currencies supported by MoonPay.
- [Check Customer's IP address](https://dev.moonpay.com/reference/getipaddress-1.md): Returns information about an IP address. If the `isAllowed` flag is set to <span class="value">false</span>, it means that MoonPay accepts citizens of this country but not residents.
- [/v1/defi/token](https://dev.moonpay.com/reference/defitokencontrollergetdefitoken.md): Retrieve defi token for a specific contractAddress and network code
- [/v1/defi/tokens](https://dev.moonpay.com/reference/defitokencontrollergetdefitokens.md): Search and retrieve a paginated list of defi tokens
- [NFT information endpoint](https://dev.moonpay.com/reference/get_asset-info-contractaddress-tokenid.md): This endpoint allows MoonPay to get required information about an NFT. It's used by the widget and MoonPay's server to get the NFT price, availability and more.
- [Generate calldata to deliver the NFT](https://dev.moonpay.com/reference/post_calldata.md): This endpoint will be called by MoonPay to generate calldata required to conduct NFT purchase on chain.
- [Deliver NFT request](https://dev.moonpay.com/reference/post_lite-deliver-nft-contractaddress-tokenid.md): This endpoint will be called by MoonPay to instruct you to deliver the NFT. Once a request is received, proceed to deliver the NFT to the buyerWalletAddress.
- [Transaction Status](https://dev.moonpay.com/reference/get_transaction-status.md): This endpoint will be called by MoonPay to retrieve the status of the NFT.
- [Overview](https://dev.moonpay.com/reference/reference-webhooks-overview.md): 👀 Getting started with our webhooks
- [Buy](https://dev.moonpay.com/reference/reference-webhooks-buy.md): 💳 Buy transaction events
- [Sell](https://dev.moonpay.com/reference/reference-webhooks-sell.md): 💰 Sell transaction events
- [Virtual Accounts](https://dev.moonpay.com/reference/reference-webhooks-virtual-accounts.md)
- [Identity Check](https://dev.moonpay.com/reference/identity-check.md): Identity Transaction Events
- [Request signing](https://dev.moonpay.com/reference/reference-webhooks-signature.md): ✍️ Protecting your sensitive data
- [Create a new partner account](https://dev.moonpay.com/reference/createpartneraccount.md): Create a new partner account with required information. Returns a link to fill in KYB information for required level and the partner account ID. The partner account ID can be used to retrieve API keys and update domains. The partner account will be in pending status until the KYB information is submitted and approved.  Use MoonPay - Server-to-Server authentication with live secret API key as the Authorization header.
- [Get partner account with its API keys](https://dev.moonpay.com/reference/getpartneraccount.md): Get partner account properties including API keys. The API keys can be used to authenticate requests to the MoonPay API.  Use MoonPay - Server-to-Server authentication with live secret API key as the Authorization header.
- [Update domains](https://dev.moonpay.com/reference/updatedomains.md): Update the list of domains to whitelist for the partner account.  Use MoonPay - Server-to-Server authentication with live secret API key as the Authorization header.
- [Get a list of countries](https://dev.moonpay.com/reference/getcountries-1.md): Get a list of countries supported by MoonPay. The list includes the country name, country code, and whether the country is supported by MoonPay.  Use MoonPay - Server-to-Server authentication with live secret API key as the Authorization header.
- [Get a list of industries](https://dev.moonpay.com/reference/getindustries.md): Get a list of industries supported by MoonPay. The list includes the industry name and whether the industry is supported by MoonPay.  Use MoonPay - Server-to-Server authentication with live secret API key as the Authorization header.
- [Get virtual accounts](https://dev.moonpay.com/reference/virtualaccountcontrollergetvirtualaccounts.md)
- [Update on ramp virtual account](https://dev.moonpay.com/reference/virtualaccountonrampcontrollerupdateonrampvirtualaccount.md)
- [Get off ramp transactions](https://dev.moonpay.com/reference/virtualaccounttransactionscontrollergetofframptransactions.md)
- [Get off ramp transaction](https://dev.moonpay.com/reference/virtualaccounttransactionscontrollergetofframptransaction.md)
- [Get on ramp transactions](https://dev.moonpay.com/reference/virtualaccounttransactionscontrollergetonramptransactions.md)
- [Get on ramp transaction](https://dev.moonpay.com/reference/virtualaccounttransactionscontrollergetonramptransaction.md)