Skip to content
API reference/REST API/
/
Query withdrawal history

Query withdrawal history

Request

Query withdrawal transaction history for current user. Transactions are sorted by createdTime.

Security
SSO_TOKEN
Query
currencystring, <= 17 characters

Digital asset code.

txIdstring, <= 256 characters

External blockchain transaction ID.

statusinteger

An integer that indicates the status of the withdrawal transactions to return:

  • 0 = email sent
  • 1 = cancelled
  • 2 = awaiting approval
  • 3 = rejected
  • 4 = processing
  • 5 = failure
  • 6 = completed
limitinteger, <= 1000

Number of records to return. Max value of 1000. If your query results in more than 1000 transactions, only the first 1000 are returned.

startTimeinteger, (int64)

Start of time period of withdrawals to return based on the transaction's createdTime.

Unix time in milliseconds.

If you specify startTime and do not specify endTime, the current time is used. The startTime must be before endTime.

endTimeinteger, (int64)

End of time period of withdrawals to return based on the transaction's createdTime.

Unix time in milliseconds.

If this parameter is specified, you must also specify a startTime value before endTime.

If you specify startTime and do not specify endTime, the current time is used.

GET
/custody/v2/withdraw/history
JavaScript
const query = new URLSearchParams({
  currency: 'string',
  txId: 'string',
  status: '0',
  limit: '1000',
  startTime: '0',
  endTime: '0'
}).toString();

const resp = await fetch(
  `https://docs.fxinside.net/_mock/openapi/integral-api-reference/rest/custody/v2/withdraw/history?${query}`,
  {
    method: 'GET',
    headers: {
      SSO_TOKEN: 'YOUR_API_KEY_HERE'
    }
  }
);

const data = await resp.text();
console.log(data);

Responses

Successful operation

Headers
X-Rate-Limitinteger, (int32)

Calls per hour allowed by the user

Bodyapplication/json
Array [
idstring, <= 255 characters

Withdrawal transaction ID.

Example:"769800519366885376"
amountstring, <= 32 characters

Withdrawal amount.

Example:"0.01"
transactionFeestring, <= 32 characters

The fee for the transaction, if any.

Example:"0.0001"
currencystring, <= 17 characters

Digital asset code.

Example:"BTC"
networkstring, <= 255 characters

Chain name / network

Example:"BTC"
statusinteger

An integer that indicates the status of the withdrawal transactions to return:

  • 0 = email sent
  • 1 = cancelled
  • 2 = awaiting approval
  • 3 = rejected
  • 4 = processing
  • 5 = failure
  • 6 = completed
Example:0
addressstring, <= 255 characters

Withdrawal address.

Example:"bc1qrpp7g75sx3ejclvsfdw2uahzchtyu7vumkuadu"
tagstring, <= 255 characters

Additional field required by some blockchains for identifying the transaction recipient beyond a wallet address.

Example:""
txIdstring, <= 255 characters

Transaction ID.

Example:"98A3EA560C6B3336D348B6C83F0F95ECE4F1F5919E94BD006E5BF3BF264FACFC"
createdTimeinteger, (int64)

The time the transaction was created. Unix time in milliseconds.

Example:1661493146000
updatedTimeinteger, (int64)

The time the transaction was updated. Unix time in milliseconds.

Example:1661493146000
reasonstring, <= 255 characters
Example:"Rejection reason"
]
Response
[
  {
    "id": "769800519366885376",
    "amount": "0.01",
    "transactionFee": "0.0001",
    "currency": "BTC",
    "network": "BTC",
    "status": 0,
    "address": "bc1qrpp7g75sx3ejclvsfdw2uahzchtyu7vumkuadu",
    "tag": "",
    "txId": "98A3EA560C6B3336D348B6C83F0F95ECE4F1F5919E94BD006E5BF3BF264FACFC",
    "createdTime": 1661493146000,
    "updatedTime": 1661493146000,
    "reason": "Rejection reason"
  }
]