Parameter | Type | Description |
---|
accounts | Array of VaultAccount | List of vault account objects |
paging | object | This object contains two fields: "before" (string) and “after” (string) |
previousUrl | string | URL string of the request for the previous page |
nextUrl | string | URL string of the request for the next page |
Parameter | Type | Description |
---|
id | string | The ID of the Vault Account |
address | string | Address of the asset in a Vault Account, for BTC/LTC the address is in Segwit (Bech32) format, cash address format for BCH |
legacyAddress | string | Legacy address format for BTC/LTC/BCH |
tag | string | Used as destination tag for XRP; memo for EOS/XLM |
eosAccountName | string | Returned for EOS, the account name |
Parameter | Type | Description |
---|
id | string | The ID of the asset |
total | string | The total wallet balance. |
balance | string | Deprecated - replaced by "total" |
available | string | Funds available for transfer. Equals the blockchain balance minus any locked amount |
pending | string | The cumulative balance of all transactions pending to be cleared |
staked | string | Staked funds, returned only for DOT |
frozen | string | Frozen by the AML policy in your workspace |
lockedAmount | string | Funds in outgoing transactions that are not yet published to the network |
totalStakedCPU | string | [optional] Deprecated |
totalStakedNetwork | string | [optional] Deprecated |
selfStakedCPU | string | [optional] Deprecated |
selfStakedNetwork | string | [optional] Deprecated |
pendingRefundCPU | string | [optional] Deprecated |
pendingRefundNetwork | string | [optional] Deprecated |
blockHeight | string | The height (number) of the block of the balance |
blockHash | string | The hash of the block of the balance |
Parameter | Type | Description |
---|
assetId | string | The ID of the asset |
address | string | Address of the asset in a Vault Account, for BTC/LTC the address is in Segwit (Bech32) format, for BCH cash format |
legacyAddress | string | For BTC/LTC/BCH the legacy format address |
description | string | Description of the address |
tag | string | Used as destination tag for XRP; memo for EOS/XLM; Bank Transfer Description for fiat providers |
type | string | Address type |
customerRefId | string | [optional] The ID for AML providers to associate the owner of funds with transactions |
bip44AddressIndex | number | [optional] The address_index , addressFormat , and enterpriseAddress in the derivation path of this address based on BIP44 |
Parameter | Type | Description |
---|
address | string | Address of the asset in a Vault Account, for BTC/LTC the address is in Segwit (Bech32) format, cash address format for BCH |
legacyAddress | string | Legacy address format for BTC/LTC/BCH |
tag | string | Used as destination tag for XRP; memo for EOS/XLM |
bip44AddressIndex | number | The address_index in the derivation path of this address based on BIP44 |
Parameter | Type | Description |
---|
id | string | The ID of the Vault Account |
name | string | Name of the Vault Account |
hiddenOnUI | boolean | Specifies whether this vault account is visible in the web console or not |
customerRefId | string | [optional] The ID for AML providers to associate the owner of funds with transactions |
autoFuel | boolean | Specifies whether this account's Ethereum address is auto-fueled by the Gas Station or not |
assets | Array of VaultAsset | List of assets under this Vault Account |
📘
Note
When the VAULT_ACCOUNT_ADDED webhook is used, the VaultAccount object does not contain the customerRefId
and autoFuel
parameters.
Parameter | Type | Description |
---|
input | Input | An object containing the txHash and index of this input |
address | string | The destination address of this input |
amount | string | The amount of this input |
confirmations | number | Number of confirmations for the transaction of this input |
status | string | The status is based on the status of the transaction |
Parameter | Type | Description |
---|
publicKey | string | The requested public key |
algorithm | string | One of the SigningAlgorithms |
derivationPath | Array of numbers | Used for BIP32 derivation to retrieve the public key |
Parameter | Type | Description |
---|
algorithm | string | [ MPC_ECDSA_SECP256K1, MPC_EDDSA_ED25519 ] |