Skip to main content

Submit order

Interface address: /api/v1/order/create-order
Notes: Use to create orders

Request input parameters

ParameterTypeMandatoryDescription
merchantOrderStringYMerchant order's unique tag
typeStringY0: Create a new order (by default).
1: Resubmit a new order. "merchantOrder" must be consistent. Nothing can be updated except for "quoteId".
userIdStringYUser's unique tag
businessTypeStringYBusiness type: BUY/SELL
clientIpStringYClient IP address
merchantUserLevelStringNMerchant user level 0 – 4
quoteObjectYQuote information
cardObjectYCard information
paymentObjectYPayment information
withdrawObjectYWithdrawal information

Request input parameters (quote)

ParameterTypeMandatoryDescription
quoteIdLongNQuote ID. When entered, an order will be created based on this quote, which must be still valid. Orders cannot be created with expired quotes. The quote ID must be consistent with the parameters of crypto, amount, and fiatCurrency. If there is no Quote ID, one will be generated at the time the order is created based on the quote.
cryptoCurrencyStringNCryptocurrency to buy
fiatCurrencyStringNFiat currency to be paid
fiatAmountStringNFiat amount to be paid by the user

Request input parameters (card)

ParameterTypeMandatoryDescription
cardIdStringYCard ID to be used by the user. Only allowed to enter when the payment method is a card. Verify that the card ID matches the user ID.
fullNameStringNCardholder name
countryStringNCountry/region
addressStringNBilling address
cityStringNCity
postalCodeStringNPostal code
phoneStringNPhone number
areaCodeStringNCountry code of the phone number

Request input parameters (payment)

ParameterTypeMandatoryDescription
payWayCodeStringYPayment method to be used by the user
redirectUrlStringYUsers will be redirected to this address after payment. When using API, this parameter is passed through to "checkout".
failUrlStringYUsers will be redirected to this address if payment failed. When using API, this parameter is passed through to "checkout".
callbackUrlStringYPush address for the order's webhook.
deviceSessionIdStringYView generation method
forterTokenStringNForter token
cybsTokenStringNCybs token

Request input parameters (withdraw)

ParameterTypeMandatoryDescription
networkStringNThe network associated with the cryptocurrency.
Merchant type: "network" is mandatory for on-chain mode and optional for off-chain mode.
transferAddressStringNMerchant type: Provide the receiver's on-chain address in on-chain mode.
transferModeStringNCHAIN: on-chain
merchantUserStringNUser's unique ID on the merchant end.
Merchant type: "merchantUser" is mandatory for off-chain mode.

Output parameters

ParameterTypeMandatoryDescription
orderIdStringYOrder ID

How was your Reading Experience with us?

footer_logoCopyright
socialsocialsocial
Quadrum Verslo Centra, Konstitucijos pr 21, Vilnius 08130 , Lithuania