Consolidate account

post/api/v2/{coin}/wallet/{walletId}/consolidateAccount/build

Consolidates the receive address balances in the main address of a wallet. Algorand is an account-based coin. For some account-based coins, creation of receive addresses results in additional accounts, associated with the main wallet account. Funds can only be sent from the main address account. Therefore, funds must be consolidated before sending. Supported by Algorand, Tezos.

Path Parameters

  • coinstringRequired
    This route is only available for Algorand and Tezos.
    Enum: algotalgoxtztxtz
  • walletIdstringRequired
    Example: "59cd72485007a239fb00282ed480da1f"
    Pattern: ^[0-9a-f]{32}$

Request Body

consolidateAddresses array[string]
Optional: restrict the consolidation to the specified receive addresses. If not provided, will consolidate the funds from all receive addresses.
javascript
1 2 3 4 5 6 7 8 9 10 let params = { consolidateAddresses: [ 'BVMEUTF37WNEQ6GYCZISRFHGLEMOKT5OCPPTTJXVED6JBSXKF6YJJRZRI4', '7ITFVRNTLUHLD4F2PIIYXXIQOAJAPRGMA7JHSN3SFH2BACLK7WM6CHT524', ], }; wallet.consolidateAccount(params).then(function (transactions) { // print generated transactions for signing console.dir(transaction); });

200 Response

keyDerivationPath string

400 Response

One of
error string required
Human-readable error message
requestId string required
Client request id
context object
Properties that apply to a specific error name
name string required
Error code