Shift

GET 
/shifts/:shiftId

Returns the shift data.

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.

Request

Path Parameters

shiftId stringrequired

Responses

200

OK

application/json

Schema

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

integrations 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

integrations 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

Examples

Settled Fixed Shift

{
  "id": "dda3867168da23927b62",
  "createdAt": "2022-06-14T11:29:11.661Z",
  "depositCoin": "BTC",
  "settleCoin": "BCH",
  "depositNetwork": "bitcoin",
  "settleNetwork": "bitcoincash",
  "depositAddress": "19dENFt4wVwos6xtgwStA6n8bbA57WCS58",
  "settleAddress": "bitcoincash:qplfzeasde8cedsd4wq5zwnlp2qwtl7j25rf69kwkr",
  "depositMin": "0.0013171",
  "depositMax": "0.0013171",
  "refundAddress": "19dENFt4wVwos6xtgwStA6n8bbA57WCS58",
  "type": "fixed",
  "quoteId": "459abd73-71cd-40ac-b4b0-58b90386ce53",
  "depositAmount": "0.0013171",
  "settleAmount": "0.2293151",
  "expiresAt": "2022-06-14T11:44:09.386Z",
  "status": "settled",
  "updatedAt": "2022-06-14T11:31:26.068Z",
  "depositHash": "e23491d7125c0ed36182a12b6eddeda0bed466a2239a6bd1f8838fe30dd38a96",
  "settleHash": "d1cc670a82903aaf0de38dabde519b0c1e07b123456b3e5cd0f43e9d014cd4a7",
  "depositReceivedAt": "2022-06-14T11:29:29.114Z",
  "rate": "174.106066357908"
}

Settled Variable Shift

{
  "id": "f173118220f1461841da",
  "createdAt": "2022-06-14T10:58:44.868Z",
  "depositCoin": "LTC",
  "settleCoin": "BTC",
  "depositNetwork": "litecoin",
  "settleNetwork": "bitcoin",
  "depositAddress": "MRHrYyu9H5dFXvqHcUMfY3h7Nsyt1dhR5T",
  "settleAddress": "3213dAuUQB9CFK1s9vUJLSmhTxdHPSCRne",
  "depositMin": "0.28164145",
  "depositMax": "902.69693964",
  "type": "variable",
  "depositAmount": "1.34673526",
  "settleAmount": "0.00256814",
  "expiresAt": "2022-06-21T10:58:44.818Z",
  "status": "settled",
  "updatedAt": "2022-06-14T11:00:16.437Z",
  "depositHash": "f3140b39b1e5ab28332ffc6108bf469907ecf4b339001179d277ac38aa08d732",
  "settleHash": "4d079bdb671716563796706e383aa3d9135b123f8f238ae1e39c836fe89f87a6",
  "depositReceivedAt": "2022-06-14T10:59:17.182Z",
  "rate": "0.001906937522"
}

Refund

{
  "id": "3907c0c08d9791ed1fc1",
  "createdAt": "2024-05-24T23:40:35.726Z",
  "depositCoin": "BNB",
  "settleCoin": "USDT",
  "depositNetwork": "bsc",
  "settleNetwork": "bsc",
  "depositAddress": "0x9Ee1119931c1C0C1aCF49c82E8D68532E665e066",
  "settleAddress": "0xF189eD5F2102402B5E8BD03936b009030f5732c7",
  "depositMin": "0.0167",
  "depositMax": "0.0167",
  "type": "fixed",
  "quoteId": "46a272bb-0234-4429-ac30-135dc9a92477",
  "depositAmount": "0.01",
  "expiresAt": "2024-05-24T23:55:27.526Z",
  "status": "refund",
  "averageShiftSeconds": "24.435887",
  "updatedAt": "2024-05-24T23:41:44.181Z",
  "depositHash": "0x9b56e915677ab1bfb678d9ad6846cd724c538496cb199a4045032745f719a88a",
  "depositReceivedAt": "2024-05-24T23:41:32.305Z",
  "rate": "586.537938323353",
  "issue": "incorrect amount"
}

Refunded

{
  "id": "6821efcf996558f0053e",
  "createdAt": "2023-09-28T06:23:26.609Z",
  "depositCoin": "BNB",
  "settleCoin": "USDT",
  "depositNetwork": "bsc",
  "settleNetwork": "bsc",
  "depositAddress": "0x3fC91A3afd70395Cd496C647d5a6CC9D4B2b7FAD",
  "settleAddress": "0xd1a8ADC8ca3a58ABbbD206Ed803EC1F13384ba3c",
  "depositMin": "0.01459649",
  "depositMax": "0.01459649",
  "refundAddress": "0xd1a8ADC8ca3a58ABbbD206Ed803EC1F13384ba3c",
  "type": "fixed",
  "quoteId": "2d2d6cff-2a64-47e4-8add-8cbd368cc894",
  "depositAmount": "0.01559649",
  "expiresAt": "2023-09-28T06:35:02.326Z",
  "status": "refunded",
  "averageShiftSeconds": "59.761047",
  "updatedAt": "2023-09-28T06:29:32.829Z",
  "depositHash": "0x1477d3601be826e033301196d2eb6abdd16a28584805dae8bc1ced07d0444caa",
  "settleHash": "0xccf5021fcadd7ca624ae89a2a16ba70c28f39ff3beafddb2dfaa0adcde427d4b",
  "depositReceivedAt": "2023-09-28T06:26:14.406Z",
  "rate": "205.528863445938"
}

Expired Fixed Shift

{
  "id": "890f45d6068d5340c1bd",
  "createdAt": "2023-10-17T01:06:59.148Z",
  "depositCoin": "BUSD",
  "settleCoin": "BNB",
  "depositNetwork": "bsc",
  "settleNetwork": "bsc",
  "depositAddress": "0x3fC91A3afd70395Cd496C647d5a6CC9D4B2b7FAD",
  "settleAddress": "0xd1a8ADC8ca3a58ABbbD206Ed803EC1F13384ba3c",
  "depositMin": "3",
  "depositMax": "3",
  "type": "fixed",
  "quoteId": "227d3cbd-15de-4581-80ac-17241b5410da",
  "depositAmount": "3",
  "settleAmount": "0.01370241",
  "expiresAt": "2023-10-17T01:14:16.692Z",
  "status": "expired",
  "averageShiftSeconds": "61.12102",
  "rate": "0.00456747"
}

Expired Variable Shift

{
  "id": "dbb127698bb29fb5a8cd",
  "createdAt": "2024-01-31T04:07:11.664Z",
  "depositCoin": "USDT",
  "settleCoin": "USDT",
  "depositNetwork": "bsc",
  "settleNetwork": "ethereum",
  "depositAddress": "0xc1117a7BC4be7E788F16F600Dd8e223d1ED5525B",
  "settleAddress": "0x7Ac93c0198bF5E28894696cF25e9581e46A6550a",
  "depositMin": "31.44",
  "depositMax": "40000",
  "type": "variable",
  "expiresAt": "2024-01-31T04:12:23.440Z",
  "status": "expired",
  "averageShiftSeconds": "45.815665",
  "settleCoinNetworkFee": "3.0000"
}

Multiple

{
  "id": "fa2e733e13d08d323bsd",
  "createdAt": "2023-10-17T08:35:58.836Z",
  "depositCoin": "ETH",
  "settleCoin": "BNB",
  "depositNetwork": "ethereum",
  "settleNetwork": "bsc",
  "depositAddress": "0xf584314e9a924Cf590A62E903466A14E54a81874",
  "settleAddress": "0x2b35e5bDd11c1d1F3D7e2D5a91bc3A1641de9a0c",
  "depositMin": "0.001892087919",
  "depositMax": "8.368070030783",
  "type": "variable",
  "expiresAt": "2023-10-24T08:35:58.835Z",
  "status": "multiple",
  "deposits": [
      {
          "updatedAt": "2023-10-17T08:37:38.018Z",
          "depositHash": "0x21aa7c3335d5f8f0ea66830c9dbbec669218e2ebf4a52db73f7ad3cbafe3cd17",
          "depositReceivedAt": "2023-10-17T08:37:36.219Z",
          "depositAmount": "0.001",
          "status": "pending"
      },
      {
          "updatedAt": "2023-10-17T08:40:55.092Z",
          "depositHash": "0x9be372c850f482bee08695b217af364eb7a0467b3a4955f3fd99d568da2a9A03",
          "settleHash": "0x918b876f19a9c2130a2ba00c7311f460d8997cca387e3d9836d57d6dcb38d4c1",
          "depositReceivedAt": "2023-10-17T08:39:41.346Z",
          "depositAmount": "0.001",
          "settleAmount": "0.00620308",
          "rate": "6.20308",
          "status": "settled"
      }
  ],
  "averageShiftSeconds": "60.882891"
}

404

Not Found

application/json

Schema

Schema

error object
message stringrequired

Example

{
  "error": {
    "message": "Order not found"
  }
}

Loading...