Common
Commonly supported parameters across the widget to customize the widget behavior
| Parameter | Type | Description |
|---|---|---|
| apiKey | string | The unique identifier provided by the Onramper team |
| mode | string | A comma-separated list of widget modes to support (e.g., buy,sell).` |
| partnerContext | string | A unique string; is used to identify each session. |
| successRedirectUrl | string | Specifies a redirect URL for successful transaction completion. |
| failureRedirectUrl | string | Specifies a redirect URL for a failed transaction. |
API Key
Your API key uniquely identifies you as a client — and it’s essential for configuring features like coverage, recommendations, webhook support, and other important settings.
With your API key added, your URL will look something like this:
https://buy.onramper.com/?apiKey=pk_prod_01HETEQF46GSK6BS5JWKDF31BT
Partner Context
partnerContext is a unique string used to identify each session. It must be a valid string format. This identifier will be included in every webhook payload and the response for each order retrieval request.
With the partnerContext, the URL will look like this
https://buy.onramper.com?apiKey=pk_prod_01HETEQF46GSK6BS5JWKDF31BT&partnerContext=<partner_context>Success Redirect URL
successRedirectUrl specifies a URL for redirecting the user after a successful transaction completion. It's important to note that not all providers support this feature. Availability can be checked on the Feature Support. The URL should be URL-encoded.
https://buy.onramper.com?apiKey=pk_prod_01HETEQF46GSK6BS5JWKDF31BT&successRedirectUrl=https%3A%2F%2Fonramper.com%2FFailure Redirect URL
failureRedirectUrl specifies a URL for redirecting the user after a failed transaction. It's important to note that not all providers support this feature. Availability can be checked on the Feature Support. The URL should be URL-encoded.
https://buy.onramper.com?apiKey=pk_prod_01HETEQF46GSK6BS5JWKDF31BT&failureRedirectUrl=https%3A%2F%2Fonramper.com%2FUpdated 6 months ago