Crypto Ramp API
Retrieve a redirect URL
api
get
/buy

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.

note

The fiatAmount in the Redirect URL is provided in minor currency units. For example, GBP 12.00 is represented as 1200.

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
Query Parameters

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

The fiat amount to exchange for crypto.

The symbol of the cryptocurrency (token) to purchase.

Possible values: [card, revolut]

The payment method to use to pay for the purchase.

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.

Possible values: Value must match regular expression ^(?:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})|(?:[0-9a-zA-Z]{26})$

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.

Header Parameters
Header Parameters

Your API key that you received during integration setup. For more information, see the Authorization section above.

Response

The requested redirect URL

note

The fiatAmount in the Redirect URL is provided in minor currency units. For example, GBP 12.00 is represented as 1200.

Response body
Body object

The URL to Revolut Ramp to which to redirect the customer for the purchase.

Was this page helpful?
Loading...