Skip to main content

Create variable shift

POST 

/shifts/variable

For variable rate shifts, the settlement rate is determined when the user's deposit is received.

For shifts that return a depositMemo, the deposit transaction must include this memo, otherwise the deposit might be lost.

For shifts settling in coins where hasMemo is true in the /coins endpoint, API users are allowed to specify a settleMemo field, for example "settleMemo": "123343245".

When defining non-native tokens like AXS and USDT for depositCoin and/or settleCoin, the depositNetwork and settleNetwork fields must also be specified. This also applies to native tokens like ETH that supports multiple networks.

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

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

info

x-sideshift-secret is your account's private key.

commissionRate optional parameter can be used to offer a better rate for your users by reducing the affiliate commission paid by SideShift.

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

averageShiftSeconds represents the average time in seconds it takes for SideShift to process a shift once the users deposit is confirmed in the blockchain

settleCoinNetworkFee represents the estimated sum of network fees charged for the shift denominated in settle coin.

networkFeeUsd represents the estimated sum of network fees charged for the shift denominated in USD.

Request

Header Parameters

    x-sideshift-secret stringrequired
    x-user-ip string

    end-user IP address for integrations API requests

Body

    settleAddress stringrequired
    settleMemo string

    for coins with hasMemo is true

    refundAddress string
    refundMemo string
    depositCoin stringrequired
    settleCoin stringrequired
    depositNetwork string

    required for non-native tokens (e.g. AXS, USDT) and multi-network native tokens (e.g. ETH).

    settleNetwork string

    required for non-native tokens (e.g. AXS, USDT) and multi-network native tokens (e.g. ETH).

    affiliateId stringrequired

Responses

OK
Schema
    id stringrequired
    createdAt stringrequired
    depositCoin stringrequired
    settleCoin stringrequired
    depositNetwork stringrequired
    settleNetwork stringrequired
    depositAddress stringrequired
    depositMemo string
    settleAddress stringrequired
    settleMemo string
    depositMin stringrequired
    depositMax stringrequired
    refundAddress string
    refundMemo string
    type stringrequired
    expiresAt stringrequired
    status stringrequired
    averageShiftSeconds stringrequired
    settleCoinNetworkFee stringrequired
    networkFeeUsd stringrequired
Loading...