Ctrl+K

Get list of potentially stuck transactions and their nonces for eth-like coins

get/api/v2/{coin}/wallet/{walletId}/potentialStuckTxs

Gets a list of potentially problematic transactions, their nonces, the reason they are stuck, and possible solutions for a given wallet.

Path Parameters

  • walletIdstringRequired
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
    Min length: >= 1 characters
  • coinstringRequired
    A cryptocurrency symbol or token ticker symbol
    Example: btc
    Min length: >= 1 characters

Query Parameters

  • expandSendTransferMetadatabooleanDefault: false
    True, if expanding the send transfer for each stuck transaction if one is available.
  • txidstring
    The transaction ID of the stuck transaction.

200 Response

nonce number
The nonce value of the potentially stuck transaction
Example: 200000
txHex string
Serialized transaction hex
Example: 01000000000101d58f82d996dd872012675adadf4606734906b25a413f6e2ee535c0c10aef96020000000000ffffffff028de888000000000017a914c91aa24f65827eecec775037d886f2952b73cbe48740420f000000000017a9149304d18497b9bfe9532778a0f06d9fff3b3befaf870500473044022023d7210ba6d8bbd7a28b8af226f40f7235caab79156f93f9c9969fc459ea7f73022050fbdca788fba3de686b66b3501853695ff9d6f375867470207d233b099576e001000069522103d4788cda52f91c1f6c82eb91491ca76108c9c5f0839bc4f02eccc55fedb3311c210391bcef9dcc89570a79ba3c7514e65cd48e766a8868eca2769fa9242fdcc796662102ef3c5ebac4b54df70dea1bb2655126368be10ca0462382fcb730e55cddd2dd6a53aec8b11400
txId string
The on-chain transaction id
Example: b8a828b98dbf32d9fd1875cbace9640ceb8c82626716b4a64203fdc79bb46d26
sendTransfer object
baseValue number
The value (in base units) sent by this transfer, excluding network fees. BitGo is deprecating this field in the future.
baseValueString string
The value (in base units) sent by this transfer, excluding network fees represented as a string. BitGo is deprecating this field in the future.
Example: 2000000
Match pattern: ^-?\d+$
bitgoOrg string
Allowed values: BitGo Trust BitGo New York BitGo Germany BitGo Switzerland BitGo Europe ApS Frankfurt DE Trust BitGo Singapore BitGo Korea BitGo Custody MENA FZE BitGo Sister Trust 1 BitGo Inc
coin string required
A cryptocurrency symbol or token ticker symbol
Example: btc
comment
string or null
A comment from the user
date string <date-time>required
The date this Transfer was last updated
enterprise string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
entries array[object] required
An array of objects describing the change in address balances made as a result of this Transfer
history array[object] required
An audit log of events that have happened to the Transfer during its lifecycle
id string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
organization string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
pendingApproval string
replacedBy array[string]
Transaction IDs that replace this transfer.
replaces array[string]
Transaction IDs that this transfer replaces.
stakingParams object
state string required
Allowed values: initialized pendingApproval rejected signed unconfirmed confirmed removed failed replaced deleted
txid string
The on-chain transaction id
Example: b8a828b98dbf32d9fd1875cbace9640ceb8c82626716b4a64203fdc79bb46d26
type string required
Defines whether or not this Transfer was sent or received by the user
Allowed values: send receive
usd number
The amount of USD of this Transfer (will be negative if it's a send)
usdRate number
The USD rate at the time this Transfer was created
value number
The total value (in base units) sent by this Transfer (may be approximate for ETH and other coins where amounts in base units can exceed 2^53 - 1)
valueString string required
The total value (in base units) sent by this Transfer represented as a String
Example: 2000000
Match pattern: ^-?\d+$
wallet string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
walletType string
Wallet type
Allowed values: backing cold custodial custodialPaired hot trading
cause string required
The reason the transaction is potentially stuck
message string required
Possible steps to remediate the stuck transaction.
transferIds array[string]
gasAccelerationFee object
Fee required to remediate a stuck transaction when the cause is 'fee acceleration'.
gasPrice string
Example: 200000
Match pattern: ^-?\d+$
maxFeePerGas string
Example: 200000
Match pattern: ^-?\d+$
maxPriorityFeePerGas string
Example: 200000
Match pattern: ^-?\d+$
userActionDisabled boolean
True, if manual user action is disabled on this stuck transaction
json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
[
  {
    "nonce": 200000,
    "txHex": "01000000000101d58f82d996dd872012675adadf4606734906b25a413f6e2ee535c0c10aef96020000000000ffffffff028de888000000000017a914c91aa24f65827eecec775037d886f2952b73cbe48740420f000000000017a9149304d18497b9bfe9532778a0f06d9fff3b3befaf870500473044022023d7210ba6d8bbd7a28b8af226f40f7235caab79156f93f9c9969fc459ea7f73022050fbdca788fba3de686b66b3501853695ff9d6f375867470207d233b099576e001000069522103d4788cda52f91c1f6c82eb91491ca76108c9c5f0839bc4f02eccc55fedb3311c210391bcef9dcc89570a79ba3c7514e65cd48e766a8868eca2769fa9242fdcc796662102ef3c5ebac4b54df70dea1bb2655126368be10ca0462382fcb730e55cddd2dd6a53aec8b11400",
    "txId": "b8a828b98dbf32d9fd1875cbace9640ceb8c82626716b4a64203fdc79bb46d26",
    "sendTransfer": {
      "baseValue": 0,
      "baseValueString": "2000000",
      "bitgoOrg": "BitGo Trust",
      "coin": "btc",
      "comment": "string",
      "date": "2019-08-24T14:15:22Z",
      "enterprise": "59cd72485007a239fb00282ed480da1f",
      "entries": [
        {
          "address": "2NAUwNgXaoFj2VVnSEvNLGuez8CfdU2UCMZ",
          "associatedNativeCoinAddress": "string",
          "backingFeeString": "string",
          "failed": true,
          "isChange": true,
          "isFee": true,
          "isInternal": true,
          "isPayGo": true,
          "isReward": true,
          "memo": "string",
          "nftId": "string",
          "nftSymbol": "string",
          "rewardAddress": "string",
          "subtype": "string",
          "token": "omg",
          "tokenContractHash": "string",
          "type": "flushForwarderTokens",
          "value": 0,
          "valueString": "20000",
          "wallet": "59cd72485007a239fb00282ed480da1f"
        }
      ],
      "history": [
        {
          "action": "created",
          "comment": "string",
          "date": "2019-08-24T14:15:22Z",
          "transferId": "string",
          "txid": "string",
          "user": "59cd72485007a239fb00282ed480da1f"
        }
      ],
      "id": "59cd72485007a239fb00282ed480da1f",
      "organization": "59cd72485007a239fb00282ed480da1f",
      "pendingApproval": "string",
      "replacedBy": [
        "string"
      ],
      "replaces": [
        "string"
      ],
      "stakingParams": {
        "actionType": "string",
        "coreDao": {
          "amount": "string",
          "expiration": "2019-08-24T14:15:22Z",
          "fee": 0,
          "rewardAddress": "string",
          "validator": "string",
          "version": 0
        },
        "requestId": "string",
        "source": "external",
        "validator": "string"
      },
      "state": "initialized",
      "txid": "b8a828b98dbf32d9fd1875cbace9640ceb8c82626716b4a64203fdc79bb46d26",
      "type": "send",
      "usd": 0,
      "usdRate": 0,
      "value": 0,
      "valueString": "2000000",
      "wallet": "59cd72485007a239fb00282ed480da1f",
      "walletType": "backing"
    },
    "cause": "string",
    "message": "string",
    "transferIds": [
      "string"
    ],
    "gasAccelerationFee": {
      "gasPrice": "200000",
      "maxFeePerGas": "200000",
      "maxPriorityFeePerGas": "200000"
    },
    "userActionDisabled": true
  }
]

400 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id
json
1
2
3
4
5
6
{
  "name": "string",
  "context": {},
  "error": "string",
  "requestId": "string"
}