Skip to main content

Shift

GET 
/shifts/:shiftId

Returns the shift data for single shift. For bulk retrieval, use /v2/shifts?ids=shiftId1,shiftId2.

For shift that has multiple as status, the deposits array in the API response holds all deposits associated with a shift.

  • Fixed Shifts: The array will show multiple deposits, but only the first deposit is settled. Subsequent deposits are refunded.
  • Variable Shifts: Multiple deposits are listed and processed individually according to the current market rates and conditions.
note

It is not desirable for users to make multiple deposits to the same shift, and integrators should avoid encouraging this behavior.

depositAddress is unassigned from a shift after 60 days (40 days for EVM token deposit addresses). Once unassigned, the field becomes null, and the address may be assigned to other shifts. Persist the value when the shift is created if it needs to be shown later, and never send funds to addresses from expired shifts.

Request​

Path Parameters

    shiftId stringrequired

Responses​

OK
Fixed Shift Single Deposit
    id stringrequired
    createdAt stringrequired
    depositCoin stringrequired
    settleCoin stringrequired
    depositNetwork stringrequired
    settleNetwork stringrequired
    depositAddress stringrequired
    settleAddress stringrequired
    depositMin stringrequired
    depositMax stringrequired
    refundAddress string
    refundMemo string
    type stringrequired
    quoteId stringrequired
    depositAmount stringrequired
    settleAmount string

    required if shift's status is settled or expired

    expiresAt stringrequired
    status stringrequired
    averageShiftSeconds stringrequired
    externalId string

    integration’s own ID

    updatedAt string

    required if shift's status is settled or refunded

    depositHash string

    required if shift's status is settled or refunded

    settleHash string

    required if shift's status is settled or refunded

    depositReceivedAt string

    required if shift's status is settled or refunded

    rate stringrequired
    issue string
Variable Shift Single Deposit
    id stringrequired
    createdAt stringrequired
    depositCoin stringrequired
    settleCoin stringrequired
    depositNetwork stringrequired
    settleNetwork stringrequired
    depositAddress stringrequired
    settleAddress stringrequired
    depositMin stringrequired
    depositMax stringrequired
    refundAddress string
    refundMemo string
    type stringrequired
    depositAmount string

    required if shift's status is settled or refunded

    settleAmount string

    required if shift's status is settled

    expiresAt stringrequired
    status stringrequired
    averageShiftSeconds stringrequired
    externalId string

    integration's own ID

    updatedAt string

    required if shift's status is settled or refunded

    depositHash string

    required if shift's status is settled or refunded

    settleHash string

    required if shift's status is settled or refunded

    depositReceivedAt string

    required if shift's status is settled or refunded

    rate string

    required if shift's status is settled or refunded

    settleCoinNetworkFee string

    only available when shift is expired or not yet settled

Fixed Shift Multiple Deposit
    id stringrequired
    createdAt stringrequired
    depositCoin stringrequired
    settleCoin stringrequired
    depositNetwork stringrequired
    settleNetwork stringrequired
    depositAddress stringrequired
    settleAddress stringrequired
    depositMin stringrequired
    depositMax stringrequired
    refundAddress string
    refundMemo string
    type stringrequired
    quoteId stringrequired
    expiresAt stringrequired
    status stringrequired
    deposits objects[]
      updatedAt stringrequired
      depositHash stringrequired
      settleHash string
      depositReceivedAt stringrequired
      depositAmount stringrequired
      settleAmount string
      rate string
      status stringrequired
    averageShiftSeconds stringrequired
Variable Shift Multiple Deposit
    id stringrequired
    createdAt stringrequired
    depositCoin stringrequired
    settleCoin stringrequired
    depositNetwork stringrequired
    settleNetwork stringrequired
    depositAddress stringrequired
    settleAddress stringrequired
    depositMin stringrequired
    depositMax stringrequired
    refundAddress string
    refundMemo string
    type stringrequired
    expiresAt stringrequired
    status stringrequired
    deposits objects[]
      updatedAt stringrequired
      depositHash stringrequired
      settleHash string
      depositReceivedAt stringrequired
      depositAmount stringrequired
      settleAmount string
      rate string
      status stringrequired
    averageShiftSeconds stringrequired
Loading...