Use the standalone onrampPublic preview
Generate a redirect URL and mint a session for the standalone onramp.
The Stripe-hosted, standalone onramp is a prebuilt front end integration of the crypto onramp hosted at https://crypto.link.com. Platforms can integrate the crypto onramp by redirecting their users to the standalone onramp, rather than hosting an embedded version of the onramp within their application.
Before you begin
To access the Onramp API, including testing environments, you must follow these steps to submit your application. We review most onramp applications within 48 hours.
- Create or sign in to your Stripe account and submit the onramp application.
- Complete your Stripe application.
- After submitting the application, start development using testing environments.
We notify you when your application is approved or if we need more information. You can check your application status anytime by visiting the onboarding page.
No-code standalone onramp
The standalone onramp redirect URL supports parameter customisation and lets you prefill fields such as the destination currency and the source amount or destination amount.
Share the link by sending it directly to users or by displaying it with a button, as in the following demo.
Example button with redirect URL
Buy CryptoGenerate a redirect URL with code
const standaloneOnramp = window.StripeOnramp.Standalone(); const redirectUrl = standaloneOnramp.getUrl(); return ( <a href={redirectUrl}> Buy Crypto </a> );
Customise the standalone onramp
You can also generate a redirect URL with code using the Standalone
function and passing in the desired fields. Choose to either generate a redirect URL or mint a session with a redirect URL:
Customisation option | Overview | Best for |
---|---|---|
Generate a redirect URL | Generate a redirect URL in the front end without a Stripe account. Customise the suggested source or destination amount, destination currency and network. | If you want a lightweight front-end integration with light customisation and no branding. |
Mint a session with a redirect URL | Mint a session with a redirect URL in the back end with a Stripe account. Allows full customisation, including the destination wallet address. For a full list of parameters, see Pre-populate transaction parameters. | If you want a fully customised onramp with branding. |
Generate a redirect URL
Include the following scripts using script tags within the <head>
element of your HTML. These scripts must always load directly from Stripe domains (https://js.stripe.com and https://crypto-js.stripe.com) for compatibility and PCI compliance. Don’t include the scripts in a bundle or host a copy yourself. If you do, your integration might break without warning.
<head> <title>Onramp</title> <script src="https://js.stripe.com/basil/stripe.js"></script> <script src="https://crypto-js.stripe.com/crypto-onramp-outer.js"></script> </head>
Generate a redirect URL using the Standalone
function, passing in the desired parameters:
const standaloneOnramp = window.StripeOnramp.Standalone({ source_currency: 'usd', amount: {source_amount: '42'}, destination_networks: ['ethereum', 'bitcoin'], destination_currencies: ['eth', 'btc'], destination_currency: 'btc', destination_network: 'bitcoin' }); const redirectUrl = standaloneOnramp.getUrl();
You can pre-populate these parameters:
source_
: The fiat currency for the transaction (currency usd
andeur
).amount
: The fixed amount of fiat currency or cryptocurrency for this purchase. Specify a fiat amount by passing insource_
(amount {source_
) . Specify a cryptocurrency amount by passing inamount: 42} destination_
(amount {destination_
). You can only specify one amount.amount: 42} destination_
: An array of cryptocurrencies you want to restrict to (currencies ['eth', 'usdc']
).destination_
: An array of crypto networks you want to restrict to (networks ['ethereum', 'polygon']
).destination_
: The default crypto network for this onramp (network ethereum
).destination_
: The default cryptocurrency for this onramp session (currency eth
).
Redirect your users to the URL for a pre-built front-end integration of the crypto onramp on the standalone onramp.
Mint a session with a redirect URL
Similar to other integrations, you need to implement a server endpoint to create a new onramp session for every user visit. The onramp session creation request returns a redirect_
. Redirect your users to the URL for a fully customised and branded crypto onramp on the standalone onramp.
Generate a crypto onramp session with a redirect_
by running the following curl command:
curl -X POST https://api.stripe.com/v1/crypto/onramp_sessions \ -u
:sk_test_BQokikJOvBiI2HlWgH4olfQ2
You receive a response similar to the following:
{ "id": "cos_0MpKNb589O8KAxCGjmaOVF8T", "object": "crypto.onramp_session", "client_secret": "cos_0MpKNb589O8KAxCGjmaOVF8T_secret_fqV1TAdhSCFeO9FW5HnygRXca00AwEHIOu8", "created": 1679701843, "livemode": false, "redirect_url": "https://crypto.link.com?session_hash=CCwaGwoZYWNjdF8yOERUNTg5TzhLQXhDR2JMbXh5WijU7vigBjIGmyBbkqO4Oi10eFHEaFln9gFSsTGQBoQf5qRZK-A0NhiEIeH3QaCMrz-d4oYotirrAd_Bkz4", "status": "initialized", "transaction_details": { "destination_currency": null, "destination_amount": null, "destination_network": null, "fees": null, "lock_wallet_address": false, "source_currency": null, "source_amount": null, "destination_currencies": [ "btc", "eth", "sol", "usdc", "xlm" ], "destination_networks": [ "bitcoin", "ethereum", "solana", "polygon", "stellar" ], "transaction_id": null, "wallet_address": null, "wallet_addresses": null } }