Skip to main content

Create order (variable)

POST 

/orders

For variable rate orders, the settlement rate is determined when the user's payment is received.

For coins that requires memo, the API response will contain an additional memo field under depositAddress. The transaction must contain this memo, otherwise the deposit might be lost.

For orders settling in coins that requires memo, API users are allowed to specify a memo field, for example "memo": "123343245".

x-sideshift-secret header is required. It can be obtained from the account page under the account secret.

affiliateId should be defined to get a commission after the shift is complete. It can be obtained here. Commissions are paid in SideShift.ai native XAI token, read more about XAI here.

refundAddress is optional, if not defined, user will be prompted to enter a refund address manually on the SideShift.ai order page if the order needs to be refunded

orderId field is deprecated, use id instead.

estimatedNetworkFeeUsd represents the estimated amount in USD SideShift.ai will charge users for shifts involving BTC, ETH or ERC20 tokens. These fees will be deducted from the settleAmount the user receives. This field is only present in variable orders. networkFeePaidUsd represents the amount in USD SideShift.ai charged the user for network fees. This field is only present in variable orders.

commissionRate optional parameter can be used to offer a better rate for your users by reducing the affiliate commission paid by SideShift. If commissionRate is defined, affiliateId must be defined as well.

To create an order for XAI balance as settle method, the request should include the sessionSecret, settleMethod should be saibal and the settleAddress should be the affiliateId.

x-user-ip: If the API requests are sent from the integrations own server, the x-user-ip header must be set to the endusers IP address. Otherwise the requests will be blocked.

Loading...