Create and start a read-only wallet through an HSM, then add it to store.

POST 
/hsm/start

Create and start a read-only wallet through an HSM, then add it to store.

Request

application/json

Body

required

Data to start the wallet

wallet-id stringrequired

Define the key of the corresponding wallet it will be executed the request.

hsm-key stringrequired

Key name containing the BIP32 xPriv on the HSM device.

Responses

200

Start a wallet

application/json

Schema

Schema

any

success

Success

{
  "success": true
}

no-wallet-id

No wallet id parameter

{
  "success": false,
  "message": "Parameter 'wallet-id' is required."
}

no-hsm-key

No HSM key parameter

{
  "success": false,
  "message": "Parameter 'hsm-key' is required."
}

hsm-key-invalid

HSM key informed is not valid

{
  "success": false,
  "message": "Informed 'hsm-key' is not a valid xPriv."
}

start-failed

Wallet failed to start.

{
  "success": false,
  "message": "Failed to start wallet with id X and key Y"
}

wallet-already-started

Wallet with same id was already started.

{
  "success": false,
  "message": "Error starting wallet because this wallet-id is already in use. You must stop the wallet first.",
  "errorCode": "WALLET_ALREADY_STARTED"
}

Loading...