Create a wallet

post

https://your-protect-instance.example.com/api/rest/v1/wallets

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.

Body Params

currency

string

This can be a currency name or a currency ID. Needs to be the native currency of a blockchain.

name

string

required

The name of the wallet has to be unique per blockchain, network.

container

string

Deprecated: Do not use

isOmnibus

boolean

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)

comment

string

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

customerId

string

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

blockchain

string

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.

network

string

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

visibilityGroupID

string

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.

externalWalletId

string

An optional external identifier for the wallet.

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A successful response.

400Bad Request: indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax, invalid request message framing, or deceptive request routing)

401Unauthorized: indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource

403Forbidden: indicates that the server understands the request but refuses to authorize it

404Not Found: indicates that the server cannot find the requested resource

500Internal Server Error: indicates that the server encountered an unexpected condition that prevented it from fulfilling the request

503Service Unavailable: indicates that the server is not ready to handle the request.

defaultAn unexpected error response.