Wallets

Create a new wallet.

post/v2/vaults/{vault_id}/wallets

Request

Path parameters

vault_idstring required

Request body

namestring

The resource name of the wallet.

Format: vaults/{vault_id}/wallets/{wallet_id}

displayNamestring required

A human-readable name.

Must match the regular expression [a-zA-Z0-9\.,:\-'# _$]+$ and be shorter than 100 characters

externalboolean

Whether this wallet is external.

External wallets are wallets that are not managed by Utila.

archivedboolean

Whether this wallet is archived.

incompleteValueboolean

Whether converted_value omits confidential balances that could not be read. Included only when FULL view is requested.

When true, converted_value is a lower bound: the unreadable amounts count as zero.

hasFrozenAssetsboolean

Some of the assets in this wallet are frozen due to a AML policy. Included only when FULL view is requested.

networksstring[] required

The resource names of the networks of the wallet. Can be set during creation and can be added later through the CreateWalletAddress method.

Example request

{
  "name": "vaults/1b25635a5b3f/wallets/95257c5a522f",
  "displayName": "DeFi wallet",
  "hasFrozenAssets": true,
  "networks": [
    "networks/ethereum-mainnet"
  ],
  "xrplDetails": {
    "signingPubKey": "ED5F5AC8B98974A3CA843326D9B88CEBD0560177B973EE0B149F782CFAA06DC66A"
  },
  "createParams": {
    "walletGroups": [
      "vaults/1b25635a5b3f/walletGroups/95257c5a522f"
    ],
    "btcDetails": {
      "btcNetworkDetails": [
        {
          "network": "networks/bitcoin-mainnet"
        }
      ]
    }
  },
  "btcDetails": {
    "btcNetworkDetails": [
      {
        "network": "networks/bitcoin-mainnet"
      }
    ]
  }
}

Response

A successful response.

Example response

{
  "wallet": {
    "name": "vaults/1b25635a5b3f/wallets/95257c5a522f",
    "displayName": "DeFi wallet",
    "hasFrozenAssets": true,
    "networks": [
      "networks/ethereum-mainnet"
    ],
    "xrplDetails": {
      "signingPubKey": "ED5F5AC8B98974A3CA843326D9B88CEBD0560177B973EE0B149F782CFAA06DC66A"
    },
    "createParams": {
      "walletGroups": [
        "vaults/1b25635a5b3f/walletGroups/95257c5a522f"
      ],
      "btcDetails": {
        "btcNetworkDetails": [
          {
            "network": "networks/bitcoin-mainnet"
          }
        ]
      }
    },
    "btcDetails": {
      "btcNetworkDetails": [
        {
          "network": "networks/bitcoin-mainnet"
        }
      ]
    }
  }
}

Changes

    • breaking

      added to the request property allOf list

    • warning

      removed from the request property allOf list

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added to the ///// response property allOf list for the response status

    • info

      removed from the ///// response property allOf list for the response status