post https://api-sdk.lmnl.dev/api/wallet/consolidate-transaction
The Consolidate Transaction feature enables you to sweep or consolidate funds from all input addresses into a designated destination wallet.
You can transfer cryptocurrency assets from your customer addresses within your deposit wallet and consolidate them into a destination wallet. The destination wallet is typically the cold wallet. You can call the API once and consolidate funds from multiple addresses, ensuring balance sufficiency and managing gas fees, thereby reducing complexity and cost.
Prerequisites
- Ensure that the target address is whitelisted. To whitelist an address, see Whitelist a wallet address.
- Ensure that you have configured your Gas Station. For more information, refer to Gas Station.
API error responses
The following tables describe the types of error responses returned by this API.
Payload validation errors
| Error Type | HTTP Status code | Example Response | Property |
|---|---|---|---|
| address not whitelisted | 500 | { ""success"": false, ""data"": {}, ""message"": ""address is not whitelisted"", ""code"": """" } | transactions.consolidateOptions.targetAddress |
| Null or empty | 400 | { ""success"": false, ""data"": { ""errors"": [ { ""msg"": ""wallet id is required"", ""param"": ""wallet.walletId"", ""location"": ""body"" }, { ""msg"": ""wallet id should be positive number"", ""param"": ""wallet.walletId"", ""location"": ""body"" } ] }, ""message"": null } | wallet.walletId |
| invalid | 404 | { ""success"": false, ""data"": {}, ""message"": ""Wallet not found"", ""code"": """" } | wallet.walletId |
| Null or empty | 500 | { ""success"": false, ""data"": { ""errors"": [ { ""msg"": ""coin is required"", ""param"": ""wallet.coin"", ""location"": ""body"" } ] }, ""message"": null } | wallet.coin |
| invalid | 500 | { ""success"": false, ""data"": {}, ""message"": ""Invalid Coin"", ""code"": """" } | wallet.coin |
| Null or empty | 500 | { ""success"": false, ""data"": {}, ""message"": ""Target address is required for consolidation"", ""code"": """" } | transactions.consolidateOptions.targetAddress |
| unsupported chains | 500 | { ""success"": false, ""data"": {}, ""message"": ""{""chain"":""Supported to UTXO,EVM,DOT,SOL,CARDANO, NEAR, ALGORAND and TRON chains Only.""}"", ""code"": """" } | unsupported chains (xrp etc) |
Payload authorization errors
| Error Type | HTTP Status Code | Example Response | Property |
|---|---|---|---|
| Null / empty / Invalid | 401 | { ""success"": false, ""data"": {}, ""message"": ""UnAuthorized Access"", ""code"": """" } | Invalid auth Credentials |
| Null / empty / Invalid | 401 | { ""success"": false, ""data"": {}, ""message"": ""UnAuthorized Access"", ""code"": """" } | client_id |
| Null / empty / Invalid | 401 | { ""success"": false, ""data"": {}, ""message"": ""UnAuthorized Access"", ""code"": """" } | client_secret |