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
amountIndouble
amountOutdouble
symbolInstring
symbolOutstring
paymentMethodIdstring
exchangeRatedouble
koyweFeedouble
networkFeedouble
co2double
validFordouble
validUntildouble

Errors

400
Create Quote Request Bad Request Error
403
Create Quote Request Forbidden Error
422
Create Quote Request Unprocessable Entity Error