Retrieve a redirect URL

Retrieve a redirect URL to the Ramp app widget for provided buy parameters. Use it to redirect the customer to Revolut Ramp to make the purchase.

For more information, see the guides: Leverage the Crypto Ramp API -> Get a Revolut Ramp Redirect URL.

X-API-KEY

Each Crypto Ramp API request must contain an authorization header in the following format to make a call: X-API-KEY: {your_API_key}.

Before you start, make sure that you have the correct API key. For more information, see the Get started guides: Integrate with Revolut Ramp -> 2. Get Partner keys.

Request

Query Parameters

The ISO 4217 code of the selected fiat currency to use for the purchase.

The fiat amount to exchange for crypto.

The ID of the crypto token to purchase, obtained from the /config endpoint.

Possible values: [card, revolut, apple-pay, google-pay]

The selected payment option.

Example: "GB"

The ISO 3166 Alpha-2 code of the country of residence of the customer (end user) ordering the exchange.

The address of the crypto wallet into which to transfer the purchased token.

The external identifier of the order to be made. Should be either UUID or ULID.

The fee percentage that will be applied for the order as partner fee.

The URL to which to redirect the customer after the purchase – for example, your website. If not provided, the customer is shown transaction result in Revolut Ramp.

Pattern: Value must match regular expression additionalProperties.[key]=[value]

A prefix that allows passing arbitrary key-value pairs. For each pair, the prefix and key should be separated by ..

If such additional properties are provided, when you call the /orders endpoint, they are returned along with the order details.

Response

The requested redirect URL

Loading...

Retrieve a redirect URL

Authorization

X-API-KEY​

Request​

Response​

X-API-KEY

Request

Response