Sign in

v1

latestOpenAPI 3.1.02026-07-264915.3 KB

Get Quote

This end-point is used to quote a cryptocurrency price as per the payment method, fiat currency and amount.

post/quote

Request body

end_user_idstring required

Unique identifier for a user on the partner's system

digital_currencystring required
fiat_currencystring required
requested_currencystring required

The currency the user is asking a quote for

requested_amountnumber float required
wallet_idstring

Partner name, as provided by Simplex

client_ipstring required

The end user's client IP address

payment_methodsstring[]

If you want all relevant payment methods to be displayed, do not include this parameter in your request. This is our recommended approach since we will be adding new payment methods frequently. If you like to receive a quote for only one payment method or a subset of all payment methods please contact: customer.success@simplex.com

Response

Examples of succesfull and failed quote responses

OR

Example response

{
  "user_id": "11b111d1-161e-32d9-6bda-8dd2b5c8af17",
  "quote_id": "bc341244-3108-4f00-836a-97afdb786971",
  "wallet_id": "partner_name",
  "digital_money": {
    "currency": "BTC",
    "amount": 0.00927528
  },
  "fiat_money": {
    "currency": "USD",
    "base_amount": 90,
    "total_amount": 100
  },
  "valid_until": "2019-09-24T14:13:19.940Z",
  "supported_digital_currencies": [
    "BTC"
  ],
  "fees": {
    "partner_fee": {
      "amount": "10.0",
      "currency": "USD"
    },
    "payment_fee": {
      "amount": "10.0",
      "currency": "USD"
    },
    "blockchain_fee": {
      "amount": "10.0",
      "currency": "USD"
    }
  }
}