Skip to content

Retrieve quotes

Request

Allows you to retrieve a detailed quote for a user order. This endpoint should only be called when a user requests a quote by providing the cryptocurrency, fiat, amounts and payment method. This endpoint is for dynamic quotations and not to retrieve a list of static prices that can be cached. For all partners, the rate limit is capped at 500/minute for all endpoints combined which is tied to a single IP.

Path
partnerstringrequired

This is the partner code provided to you during onboarding. e.g. metamask.

orderTypestringrequired

Determines availability for Buy or Sell orders. By default if this value is not passed, then fiat availability for Buy orders will be returned.

Default:"buy"
Query
paymentMethodIdstringrequired

The payment method chosen by the user.

cryptostringrequired

This is the crypto type the customer wants to buy or sell.

blockchainstringrequired

The blockchain that the crypto token is associated with.

fiatstringrequired

This is the fiat type the customer wants to buy or sell.

cryptoAmountstringrequired

The amount of cryptocurrency the user wants to buy or sell. Either fiatAmount OR cryptoAmount must be provided. If both are provided, then cryptoAmount will be used.

fiatAmountstringrequired

The amount of fiat the user wants to buy or sell. Either fiatAmount OR cryptoAmount must be provided. If both are provided, then cryptoAmount will be used.

externalCustomerIdstring

The customer ID that you define. By passing this value, we will be able to provide the customer the most accurate pricing based on their customer details.

ipAddressstring

User’s IP address. Used to validate whether the user is in a location that is supported by Banxa. If invalid IP address or IP address associated to a country that is not supported, then an error will be returned..

discountCodestring

Allows you to configure the discount to your commission rate per quote. This can be a promotion code such as XMAS or a way to differentiate between your customers.

Headers
Acceptstring
Default:"application/json"
x-api-keystring

This is the API Key that has been provided to you during onboarding.

curl -i -X GET \
  'https://docs.banxa.com/_mock/products/hosted-checkout/openapi/{partner}/v2/quotes/{orderType}?paymentMethodId=string&crypto=string&blockchain=string&fiat=string&cryptoAmount=string&fiatAmount=string&externalCustomerId=string&ipAddress=string&discountCode=string' \
  -H 'Accept: application/json' \
  -H 'x-api-key: string'

Responses

200

Bodyapplication/json
One of:
paymentMethodIdstring
Example:"debit-credit-card"
cryptoAmountstring
Example:"0.03564700"
fiatAmountstring
Example:"100.00"
processingFeestring
Example:"0.92"
networkFeestring
Example:"1.67"
Response
"{\n \"paymentMethodId\": \"debit-credit-card\",\n \"cryptoAmount\": \"0.03564700\",\n \"fiatAmount\": \"100.00\",\n \"processingFee\": \"0.92\", //This is the payment gateway fee. \n \"networkFee\": \"1.67\"\n }"