Retrieve quotes

get

https://api.banxa.com/{partner}/v2/quotes/{orderType}

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 Params

partner

string

required

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

orderType

string

required

Defaults to buy

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

Query Params

paymentMethodId

string

required

The payment method chosen by the user.

crypto

string

required

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

blockchain

string

required

The blockchain that the crypto token is associated with.

fiat

string

required

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

cryptoAmount

string

required

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.

fiatAmount

string

required

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.

externalCustomerId

string

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.

ipAddress

string

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..

discountCode

string

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

string

Defaults to application/json

x-api-key

string

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

Response

Language

Loading…

Response

Choose an example:

application/json

200200