Skip to content

Initiate withdrawal

Request

Withdraw a digital asset from a customer wallet.

Security
SSO_TOKEN
Query
currencystring, <= 17 charactersrequired

Digital asset code.

networkstring, <= 255 charactersrequired

Chain name / network

addressstring, <= 255 charactersrequired

Withdrawal address

tagstring, <= 255 characters

Withdrawal address tag / memo

amountnumberrequired

Withdrawal amount

namestring, <= 255 characters

Withdrawal address name

JavaScript
const query = new URLSearchParams({
  currency: 'string',
  network: 'string',
  address: 'string',
  tag: 'string',
  amount: '0',
  name: 'string'
}).toString();

const resp = await fetch(
  `https://docs.fxinside.net/_mock/openapi/integral-api-reference/rest/custody/v2/withdraw/apply?${query}`,
  {
    method: 'POST',
    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
idstring

Withdrawal transaction ID.

Example:"769800519366885376"
statusany

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
errorReasonstring, <= 255 characters

Error message returned if the withdrawal fails.

Example:"Error message"
Response
{ "id": "769800519366885376", "status": 0, "errorReason": "Error message" }