Advanced Wallets - Consolidate Account

post/api/v1/{coin}/advancedwallet/{walletId}/consolidate

Build, sign, and send a consolidation transaction, all in one call. For account-based assets, consolidating the balances in the receive addresses to the base address maximizes the spendable balance of a wallet.

Retrieves the private key from KMS using the provided public key or common keychain, then signs and broadcasts the transaction.

Use this endpoint only with advanced wallets. For other wallet types, use Consolidate account (simple).

Path Parameters

  • walletIdstringRequired
  • coinstringRequired

Request Body

source string required
The key to use for signing the transaction
Allowed values: user backup
pubkey string
Public key of the key used for signing multisig transactions
consolidateAddresses array[string]
Optional: restrict the consolidation to the specified receive addresses. If not provided, will consolidate the funds from all receive addresses up to 500 addresses.
commonKeychain string
For TSS wallets, this is the common keychain of the wallet
apiVersion string
The Trasaction Request API version to use for MPC EdDSA Hot Wallets. Defaults based on the wallet type and asset curve.
Allowed values: full lite

200 Response

400 Response

error string required
The error name
details string required
Error details

404 Response

error string required
The error name
details string required
Error details

409 Response

error string required
The error name
details string required
Error details

422 Response

error string required
The error name
details string required
Error details

500 Response

error string required
The error name
details string required
Error details

501 Response

error string required
The error name
details string required
Error details