Skip to main content
Prefill all query string parameters in the Offramp URL and take users straight to the order preview screen!
Security Requirements must be enforced: Your backend API that generates session tokens must implement proper security measures. See Security Requirements for complete implementation guidance.
Should my App use One-click-sell?If your users have already selected the asset they want to sell, an amount, and/or a cashout method in your App, yes. If you want to preset these values for your users, yes.
Get a ready-to-use One-Click-Sell URL directly from the Sell Quote API by including source_address, redirect_url, and partner_user_ref parameters in your quote request!

​
Generating One-Click-Sell URLs

One-Click-Sell URLs must have following query parameters set in the URL:
  • defaultAsset
  • presetFiatAmount or presetCryptoAmount
Then it initializes Coinbase Offramp with the appropriate parameters to execute that sell. For example: 
https://pay.coinbase.com/v3/sell/input?sessionToken=<token>&partnerUserRef=testUser&redirectUrl=https://www.coinbase.com/onramp-redirect&defaultAsset=ETH&presetFiatAmount=100&quoteId=ae77980c-f656-4c69-b380-cb5cf99276a9
Crypto amount only: 
https://pay.coinbase.com/v3/sell/input?sessionToken=<token>&partnerUserRef=testUser&redirectUrl=https://www.coinbase.com/onramp-redirect&defaultAsset=BTC&presetCryptoAmount=0.001&quoteId=ae77980c-f656-4c69-b380-cb5cf99276a9

​
Query parameters

ParameterReqdTypeDescription
sessionTokenYesStringToken generated by the Session Token API.
partnerUserRefYesStringUnique ID representing the end-user. Must be less than 50 chars. Use with the Offramp Transaction Status API to retrieve transactions made during the session.
redirectUrlYesStringURL to redirect the user after they complete the offramp transaction. Add your redirectUrl in your onramp app domain allowlist on CDP portal and use Offramp Transaction Status API to fetch the send to_address details.
defaultAssetYesStringSymbol of the crypto asset to sell (e.g., ETH, BTC, USDC).

Received from Offramp Options and sent to Sell Quote.
presetFiatAmountYesNumberAmount in fiat to receive from the crypto sale. Do not add presetFiatAmount if presetCryptoAmount is present.
presetCryptoAmountYesNumberUse this instead of presetFiatAmount to specify the exact crypto amount to sell. Do not add presetCryptoAmount if presetFiatAmount is present
disableEditNoBooleanIf set to true, prevents users from editing their order in the One-Click Sell flow. Defaults to false.