Skip to navigation
Wallets and AddressesWallets

Create a wallet

This endpoint creates a new wallet.

You must specify either a currency (by ID or symbol) or a combination of blockchain and network.

  • If currency is provided, blockchain and network cannot be used.
  • If currency is not provided, you may use blockchain, network, or both together.

Only one of these approaches is allowed per request.

The currencyID is globally unique across blockchains and networks, and can be identified by querying the /currencies endpoint. We recommend using currencyID whenever possible to avoid ambiguity.

Required role: AccountCreator.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
namestringRequired
The name of the wallet has to be unique per blockchain, network.
currencystringOptional
This can be a currency name or a currency ID. Needs to be the native currency of a blockchain.
containerstringOptional

Deprecated: Do not use

isOmnibusbooleanOptional

When set to true, the Wallet can be used as source of transactions allowing the system to pick addresses with adequate funds. (This is called Single owner in the GUI)

commentstringOptional

Comment or description of the wallet (maximum 254 characters). It is not used or interpreted by the system and will be returned as is in the replies from endpoints such as api/rest/v2/wallets

customerIdstringOptional

When isOmnibus is true, all addresses in the wallet will have this attribute set (maximum 254 characters)

blockchainstringOptional

A string identifying the blockchain (e.g. "BTC"). Required if currency is empty. If the blockchain is enabled on more than one network (e.g. "mainnet" and "testnet"), the network needs to be specified.

networkstringOptional
A string identifying the network. Required if the specified blockchain is enabled on multiple networks
visibilityGroupIDstringOptional

The UUID of a Visibility Group (uuid can be obtained from e.g. api/rest/v1/visibilitygroups). The created wallet will only be visible and can only be managed by users in this group.

externalWalletIdstringOptional
An optional external identifier for the wallet.

Response

A successful response.
resultobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
503
Service Unavailable Error