Withdraw Task Status
API-v2task::withdraw::status
To get the status of your withdrawal transaction generation, use the task::withdraw::status method. Once ready, it will provide the raw hex used to broadcast your transaction with sendrawtransaction. The response returned is the same as what is returned from the standard v2 withdraw method
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| task_id | integer | ✓ | - | The identifying number returned when initiating the initialisation process. |
| forget_if_finished | boolean | ✗ | true | If false, will return final response for completed tasks. |
| Parameter | Type | Description |
|---|---|---|
| status | string | A short indication of how the withdrawal is progressing. |
| details | object | Depending on the state of withdrawal progress, this will contain different information as shown in the responses below. |
| details.to | array of strings | Coins are withdrawn to these addresses; this may contain the my_address address, where change from UTXO coins is sent. |
| details.from | array of strings | Coins are withdrawn from this address; the array contains a single element, but transactions may be sent from several addresses (UTXO coins) |
| details.my_balance_change | string (numeric) | the expected balance of change in my_address after the transaction broadcasts |
| details.received_by_me | string (numeric) | the amount of coins received by my_address after the transaction broadcasts; the value may be above zero when the transaction requires that the Komodo DeFi Framework API send change to my_address |
| details.spent_by_me | string (numeric) | the amount of coins spent by my_address; this value differ from the request amount, as the transaction fee is added here |
| details.total_amount | string (numeric) | the total amount of coins transferred |
| details.fee_details | object | the fee details of the generated transaction; fee_details.type is "Utxo" for Z coins. fee_details.coin will be the same as details.coin, and fee_details.amount will be a numeric value. |
| details.tx_hash | string | the hash of the generated transaction |
| details.tx_hex | string | transaction bytes in hexadecimal format; use this value as input for the send_raw_transaction |
| details.coin | string | the name of the coin the user wants to withdraw |
| details.transaction_type | string | Transaction type will be StandardTransfer for Z coin transactions. |
| details.kmd_rewards | object | If supported (e.g. when withdrawing KMD), an object containing information about accrued rewards. |
| details.kmd_rewards.amount | string (numeric) | The amount of accrued rewards |
| details.kmd_rewards.claimed_by_me | bool | Whether or not the rewards been claimed by me. |
task::withdraw::status
POST
task::withdraw::status{
"mmrpc": "2.0",
"userpass": "RPC_UserP@SSW0RD",
"method": "task::withdraw::status",
"params": {
"task_id": 3,
"forget_if_finished": false
},
"id": 0
}
| Parameter | Type | Description |
|---|---|---|
| NoSuchTask | string | The specified task was not found or expired. |
| TaskFinished | string | The task is already finished and cannot be canceled. |