ReDoc documentation

Buy Provider Server (1.0)

Download OpenAPI specification:Download

getCapabilities

Responses
200

Buy Provider Capabilities

  • "fiatCurrencyCapabilities.[].fiat": fiat currency supported at the ISO-4217 standard,
  • "fiatCurrencyCapabilities.[].minAmount": minimum amount in fiat the user can buy crypto,
  • "fiatCurrencyCapabilities.[].maxAmount ": minimum amount in fiat the user can buy crypto,
  • "countryCapabilities.[].country": available at the Alpha-2 standard (ISO3166),
  • "countryCapabilities.[].paymentMethods.[].name": Available payment method, valid values : visa, mastercard, creditcard, pix, mobikwik, easypay, astropay, upibanktransfer, sofort, bancontact, giropay, maestro, googlepay, applepay, paypal, sepa, ach, fasterpayments, easybank, bank, gbpbank, eps, ideal, revolut
default

Error sent by the provider

get/capabilities
Response samples
application/json
{
  • "fiatCurrencyCapabilities": [
    ],
  • "countryCapabilities": [
    ]
}

getQuote

SecurityApiKeyAuth
Request
query Parameters
from
required
string

Fiat currency at the ISO-4217 standard.

Example: from=EUR
to
required
string

Crypto currency id of the provider.

Example: to=bitcoin
payment-method
required
string

Payment method, valid values : visa, mastercard, creditcard, pix, mobikwik, easypay, astropay, upibanktransfer, sofort, bancontact, giropay, maestro, googlepay, applepay, paypal, sepa, ach, fasterpayments, easybank, bank, gbpbank, eps, ideal, revolut.

Example: payment-method=PayPal
amount
required
integer

Fiat amount to buy.

Example: amount=50
country
required
string

Country of the user at the Alpha-2 standard (ISO3166).

Example: country=FR
dest
required
string

Destination address of the buy.

Example: dest=0x000000000000000000000000000000
Responses
200

Quote information about the the buy.

  • "from": fiat currency of the buy,
  • "to": crypto currency of the buy,
  • "amount": fiat amount,
  • "cryptoAmount": crypto amount the user will have, must include all the fees.
400

Invalid value for: query parameter from, Invalid value for: query parameter to, Invalid value for: query parameter payment-method, Invalid value for: query parameter amount, Invalid value for: query parameter country, Invalid value for: query parameter dest

default

Error sent by the provider

get/quote
Response samples
application/json
{
  • "from": "EUR",
  • "to": "bitcoin",
  • "fiatAmount": 50,
  • "cryptoAmount": 0.2
}

Retrieve a redirect URL

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

SecurityApiKeyAuth
Request
query Parameters
from
required
string

Fiat currency at the ISO-4217 standard.

Example: from=EUR
to
required
string

Crypto currency id of the provider.

Example: to=bitcoin
payment-method
required
string

Payment method, valid values : visa, mastercard, creditcard, pix, mobikwik, easypay, astropay, upibanktransfer, sofort, bancontact, giropay, maestro, googlepay, applepay, paypal, sepa, ach, fasterpayments, easybank, bank, gbpbank, eps, ideal, revolut.

Example: payment-method=PayPal
amount
required
integer

Fiat amount to buy.

Example: amount=50
country
required
string

Country of the user at the Alpha-2 standard (ISO3166).

Example: country=FR
dest
required
string

Destination address of the buy.

Example: dest=0x000000000000000000000000000000
orderId
required
string

Identifier of the order

Responses
200

OK

400

Bad Request

get/buy
Response samples

getCrypto-currencies

Responses
200

Available crypto currencies

  • "id" : the provider id of the currency,
  • "type" : possible values : coin, token,
  • "blockchain" : ledger id of the blockchain in ledger_coins.json,
  • "chainId" : chain id of the blockchain,
  • "contract" : mapped only if type is token, the contract address of the token.
default

Error sent by the provider

get/crypto-currencies
Response samples
application/json
[
  • {
    },
  • {
    }
]