API DocumentationRESTful APIQuote Queries

Creates a purchase or sell quote

Only one of the input parameters “amountIn” and “amountOut” must be provided. for on ramps receives additionally clientId and paymentMethodId. Returns a quoteId that can be use to create an order (is not necessary, but if provided and still valid, fewer values will be necessary to create the order). If executable is true, we store it and return a UUID.

Request

This endpoint expects an object.
clientIdstringOptional
symbolInstringOptional
symbolOutstringOptional
amountIndoubleOptional
amountOutdoubleOptional
paymentMethodIdstringOptional

This is a crucial attribute when creating ‘on-ramp’ orders. It acts as an identifier for the payment method that will be used to receive funds. Its purpose is to ensure alignment between the system and the client regarding the transaction mechanism, paving the way for efficient transaction processing and tracking. For ‘off-ramp’ orders, providing this attribute is not required.

executablebooleanOptional

Response

successful operation
quoteIdstring or null
amountIndouble or null
amountOutdouble or null
symbolInstring or null
symbolOutstring or null
paymentMethodIdstring or null
exchangeRatedouble or null
koyweFeedouble or null
networkFeedouble or null
co2double or null
validFordouble or null
validUntildouble or null

Errors