Ctrl+K

Update a sendq state which may lead to an update to the accompanied transfer item

put/api/v2/{coin}/admin/sendq/{sendQueueId}

Path Parameters

  • coinstringRequired
    A cryptocurrency or token ticker symbol.
    Example: btc
  • sendQueueIdstringRequired
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$

Request Body

newState string
The status of this SendQueue item
Allowed values: pending attempted failed done reverted held replaced abandoned
Example: done
comment string
Justification for updating sendq item and associated issue or ticket
Example: transfer stuck in signed state and sendq stuck in attempted BG-XXXXX

200 Response

id string
Example: 59cd72485007a239fb00282ed480da1f
user string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
deployment boolean
coin string
A cryptocurrency or token ticker symbol.
Example: btc
createTime integer
modifyTime integer
state string
The status of this SendQueue item
Allowed values: pending attempted failed done reverted held replaced abandoned
Example: done
held boolean
uniqueDoubleSpendPreventionIds array[string]
txid string
The on-chain transaction id
Example: b8a828b98dbf32d9fd1875cbace9640ceb8c82626716b4a64203fdc79bb46d26
tx string
Raw txHex broadcast to fullnode
attempts integer
nextAtttempt string <date-time>
Next date this sendq will be attempted to broadcast
targetAttempts integer
Max number of attempts this sendq will be attempted to brodcast
value integer
valusString string
payGoFee integer
payGoFeeString string
agent string
feesUsed object
Fee parameters used to build transaction (depends on coin type)
maxFeePerGas integer
maxPriorityFeePerGas integer
gasPrice integer
gasLimit integer
coinSpecific object
Properties which are specific to certain coin types
wallet string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
enterprise string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
pendingApprivalId string
address string
expireTime string
submitHeight integer
confirmHeight integer
comment string
instantId string
instant boolean
error string
Response from fullnode after attempting to broadcast or a comment set during state change
firstValidBlock integer
lastValidBlock integer
customNode object
txRequestId string
lightning boolean

400 Response

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