Returns a single-use URL for an Onramp session. This API provides flexible functionality based on the parameters provided, supporting three cases:
Important: The returned URL is single-use only. Once a user visits the URL, no one else can access it.
Required: destinationAddress
, purchaseCurrency
, destinationNetwork
Returns: Basic single-use onramp URL. The quote
object will not be included in the response.
Required: Basic parameters + paymentAmount
, paymentCurrency
Returns: One-click onramp URL for streamlined checkout. The quote
object will not be included in the response.
Required: One-Click Onramp parameters + paymentMethod
, country
, subdivision
Returns: Complete pricing quote and one-click onramp URL. Both session
and quote
objects will be included in the response.
A JWT signed using your CDP API Key Secret, encoded in base64. Refer to the Generate Bearer Token section of our Authentication docs for information on how to generate your Bearer Token.
Onramp session created successfully.
The response is of type object
.