💵Step 4 - User Deposit & Withdrawal

The User will need different deposit address according to the coin selected and the network.

1 - In order to realize a deposit,

Get deposit on chain address

GET/v1/wallet/deposit/{accountId}/{asset}/{network}

Path parameters

accountId*string

asset*string

network*string

Response

200

OK

Body

*/*

successboolean

dataDepositAddressView (object)

errorCodeinteger (int32)

errorMessagestring

Request

JavaScriptCurl

const response = await fetch('/v1/wallet/deposit/{accountId}/{asset}/{network}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "data": {
    "coin": "text",
    "network": "text",
    "address": "text"
  },
  "errorMessage": "text"
}

The Trading Portfolio (PortfolioId) will be associated with an AccountId. This means that the crypto deposit, will automatically be credited to the Trading Portfolio, which is the main portfolio of the AccountId.

OAuth: client_auth

2 - To obtain the history of all the deposits of a given AccountId, you can use the following endpoint:

Get deposit history on chain

GET/v1/wallet/deposit/{accountId}/history

Path parameters

accountId*string

Response

200

OK

Body

*/*

successboolean

dataarray of Deposit (object)

errorCodeinteger (int32)

errorMessagestring

Request

JavaScriptCurl

const response = await fetch('/v1/wallet/deposit/{accountId}/history', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "data": [
    {
      "ts": "2024-07-27T06:58:42.906Z",
      "txId": "text",
      "coin": "text",
      "network": "text",
      "address": "text",
      "amount": 0
    }
  ],
  "errorMessage": "text"
}

OAuth: client_auth

3 - Using the following endpoint, you can also consult the list of the blockchains network available on Stokn for deposit:

Get network of coins

GET/v1/wallet/deposit/networks/all/{slug}

Path parameters

slug*string

Response

200

OK

Body

*/*

string

Request

JavaScriptCurl

const response = await fetch('/v1/wallet/deposit/networks/all/{slug}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

text

OAuth: client_auth

4 - Using the following endpoint, you can also consult the list of coins/tokens available on Stokn for deposit:

Get available coins for deposit

GET/v1/wallet/deposit/available-coins

Response

200

OK

Body

*/*

successboolean

dataarray of Coin (object)

errorCodeinteger (int32)

errorMessagestring

Request

JavaScriptCurl

const response = await fetch('/v1/wallet/deposit/available-coins', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "data": [
    {
      "slug": "text",
      "name": "text",
      "logoUrl": "text",
      "availableNetworks": [
        "text"
      ]
    }
  ],
  "errorMessage": "text"
}

OAuth: client_auth

5 - This is the information that must be entered to make a withdrawal: account ID, asset, network, destination address.

POST/v1/wallet/withdraw

Body

application/json

accountIdstring

networkenum

ETHBTC

addressstring

assetstring

amountnumber

Response

200

OK

Body

*/*

successboolean

dataWithdrawResponse (object)

errorCodeinteger (int32)

errorMessagestring

Request

JavaScriptCurl

const response = await fetch('/v1/wallet/withdraw', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "data": {
    "accountId": "text",
    "amount": 0,
    "asset": "text",
    "network": "text",
    "address": "text",
    "success": false,
    "message": "text",
    "portfolioId": "text",
    "operationId": "text"
  },
  "errorMessage": "text"
}

OAuth: user_auth