BVbvnk
Wallets

List crypto wallets

Changed on

Retrieves a list of wallets on your account. Displays the first 10 wallets without max set to higher.

get/api/wallet

Request

Query parameters

offsetinteger

Starting point for pagination, used instead of `page. Useful for cursor-based pagination.

maxinteger

Maximum number of items in response.

Response

OK

addressstring

The crypto wallet address

approxAvailablestring

The approximate amount availible in the wallet.

approxBalancestring

The balance amount availible of the wallet.

availablenumber float
balancenumber float

The balance of the wallet.

convertedAvailablenumber float

The availible converted amount

custodianWalletboolean

Is a custodian wallet.

depositFeenumber float

The fee to deposit funds in wallet.

descriptionstring

The description of the wallet.

idinteger

The wallet ID.

isEmoneyboolean

Is E Money Wallet

lookupstring

Is a lookup.

networkstring

The network of the wallet.

We recommend using the network parameter instead of protocol.

protocolstring

The protocol of the wallet.

supportsDepositsboolean

Is able to support deposits.

supportsThirdPartyboolean

Is a third party wallet.

supportsWithdrawalsboolean

Is able to support withdrawals.

withdrawalFeenumber float

The fee to withdraw funds from wallet.

supportsInternalBvnkNetworkTransfersboolean

Supports internal BVNK network transfers.

partnerstring

Partner information.

supportedTransferDestinationsstring[]

List of supported transfer destinations.

approxConvertedAvailablestring

The approximate converted available amount as a string.

lsidstring

The wallet LSID (Local Session ID).

status'ACTIVE' | 'INACTIVE' | 'TERMINATED'

The status of the wallet.

Example response

[
  {
    "address": "0x7be879d34f3Db833f70d9fE4873Bdd0cBcaC6bf6",
    "alternatives": [],
    "approxAvailable": "0.59573928",
    "approxBalance": "0.59573928",
    "available": 0.59573928,
    "balance": 0.59573928,
    "convertedAvailable": 20917.59,
    "currency": {
      "code": "ETH",
      "icon": "https://cdn.com/eth-icon.png",
      "id": 1432,
      "name": "Ethereum",
      "options": {
        "transaction": "https://etherscan.io/tx/{{hash}}",
        "explorer": "https://etherscan.io/",
        "address": "https://etherscan.io/address/{{address}}",
        "confirmations": 12
      },
      "protocols": [
        {
          "code": "ERC20",
          "network": "Ethereum"
        }
      ],
      "withdrawalFee": 0.01,
      "withdrawalParameters": [
        {
          "id": 1432,
          "code": "BTC",
          "name": "Bitcoin"
        }
      ]
    },
    "description": "ETH wallet",
    "id": 1432,
    "network": "ETHEREUM",
    "protocol": "ETH",
    "withdrawalFee": 0.001,
    "supportedTransferDestinations": [
      "LOCAL"
    ],
    "approxConvertedAvailable": "19.71",
    "lsid": "a:25061134333492:69iFbD6:1",
    "status": "ACTIVE"
  }
]

Changes