Skip to navigation

Get Quote

View as Markdown

The Get Quote is a public API call that allows you to fetch a temporary price quote for a cryptocurrency transaction based on the selected fiat currency, cryptocurrency, payment method, and transaction amount. Since cryptocurrency prices are volatile, the returned quote is refreshed every minute to reflect the latest market price.

After fetching the supported cryptocurrencies and fiat currencies, you must call getQuote to get the latest exchange rate. This quote is critical for KYC verification and order placement:

KYC Process:

  • The quote ID must be passed when calling Get KYC Requirement .

  • Based on the order amount, the user may be required to complete different KYC tiers (Simple KYC, Standard KYC).

Order Placement:

  • The quote ID is also required when calling createOrder()

  • At the time of payment settlement, Transak sends the exact amount of cryptocurrency based on the latest exchange rate at that moment.

Terms and disclaimers (US, EEA and UK users):

termsIds lists the disclaimers to show for this quote: provider terms for US users, MICA_EEA_BUY or MICA_EEA_SELL for EEA users, and GB_INVESTMENT_RISK_WARNING for UK users. For logged-in users, pass the user’s authentication headers for your flow, so termsIds follow the user’s KYC country:

  • Transak Auth: pass authorization with the user’s access token from the Verify User OTP API.
  • Partner Auth (Auth Reliance): pass x-access-token with your partner access token and x-user-identifier with the user’s email address.

Use either Transak Auth or Partner Auth (Auth Reliance), not both.

Show the disclaimer for each ID in termsIds before the user places the order. See How to Display Disclaimers in Your API Integration.

MiCA disclaimers (EEA users):

For EEA users, termsIds includes MICA_EEA_BUY or MICA_EEA_SELL. See How to Display Disclaimers in Your API Integration.

Thus, getQuote plays a vital role in the entire order flow, from KYC verification to order execution.

Additional Postman request: Get KYC Reliance Quote

Headers

x-user-ipstringRequired

End user’s originating IP. More details here

x-api-keystringRequired
Partner API Key present in Transak Dashboard.
authorizationstringOptional

Transak Auth. The user’s accessToken from the Verify User OTP API (/api/v2/auth/verify), sent on its own with no Bearer prefix. Pass it to receive termsIds for US, EEA and UK users. See How to Display Disclaimers in Your API Integration.

Note: Transak Auth only. Not used with Partner Auth (Auth Reliance).

x-user-identifierstringOptional

The email address of the user you authenticated. Pass it with x-access-token to receive termsIds for US, EEA and UK users. See How to Display Disclaimers in Your API Integration.

Note: Partner Auth (Auth Reliance) only. See Auth Reliance.

x-access-tokenstringOptional

Your Partner Access Token, valid for 7 days. See how to create a Partner Access Token. Pass it with x-user-identifier to receive termsIds for US, EEA and UK users. See How to Display Disclaimers in Your API Integration.

Note: Partner Auth (Auth Reliance) only. See Auth Reliance.

Query parameters

apiKeystringRequired
Your Api Key which you can get it from Transak Partner Dashboard for respective environment
fiatCurrencystringRequired

Supported fiat currency symbol from /fiat/public/v1/currencies/fiat-currencies

cryptoCurrencystringRequired

Supported crypto currency symbol from /cryptocoverage/api/v1/public/crypto-currencies

isBuyOrSellstringRequired
Value should be 'BUY' or 'SELL'
networkstringRequired

Supported crypto currency network from /cryptocoverage/api/v1/public/crypto-currencies

paymentMethodstringRequired

Supported payment method from /fiat/public/v1/currencies/fiat-currencies

fiatAmountdoubleOptional
Amount in fiat currency. For BUY, pass at least one of fiatAmount or cryptoAmount.
cryptoAmountdoubleOptional
Amount in crypto currency. For SELL, this parameter is required.
quoteCountryCodestringOptional

The user’s country as an ISO 3166-1 alpha-2 code, for example US, DE or GB, used to price the quote for that region.

partnerCustomerIdstringOptional
Unique id for user provided by partner
partnerOrderIdstringOptional
Unique id for order provided by partner

Response

200 - Success

dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error