API Deprecations

We try very hard to maintain backward compatibility with our schema but occasionally we need to deprecate some parts to streamline our code base and to make way for new features. We will always try to give as much notice as possible with changes like these. After 1st March 2023 the following parts of our schema will be deprecated and will no longer be supported. Please also note a number of input and response properties have also been changed.

If you have any concerns or queries regarding the changes please feel free to reach out to us through chat or email us at help@bitpandacustody.com and we will be happy to answer any queries you may have. You can also find further information regarding our api here.

Deprecated as of 13th June 2023 (COMPLETED)

We have been phasing out support for binance chain for the past year and as of the 13th June 2023 we will completely remove support. Please note this will not affect Binance Smart Chain which is still fully supported.

Deprecated as of 1st March 2023 (COMPLETED)

The following items in the schema will be deprecated and no longer supported from 1st March 2023, below you can find examples of some of the migrations.

Inputs

Deprecated New
CreateBitcoinAddressInput.subWalletId CreateBitcoinAddressInput.subWalletIdString
CreateBitcoinTransactionParams.fromSubWalletId CreateBitcoinAddressInput.subWalletId

Responses

Deprecated New
CreateEthereumTransactionResponse.transactionId CreateEthereumTransactionResponse.requestId
CreateEthereumTransactionResponse.trustVaultTransactionId CreateEthereumTransactionResponse.requestId
CreateXdcNetworkTransactionResponse.transctionId CreateXdcNetworkTransactionResponse.requestId
CreateBitcoinTransactionIdResponse.transctionId CreateBitcoinTransactionIdResponse.requestId
RequestItem.signature RequestItem.signatures

Types

Deprecated New
UserWallet User
User.wallets User.walletsInfo
User.wallet User.walletsInfo
UserWallet.getAccounts User.walletsInfo
UserWallet.getTransactionInfo transactionInfo
SubWallet.id SubWallet.subWalletId
BitcoinPublicKeyProvenance.accountHSMProvenanceSignature BitcoinPublicKeyProvenance.trustVaultProvenanceSignature
WalletConnection.allWalletsPortfolio User.portfolio
SubWalletConnection.allSubWalletsPortfolio User.portfolio

Examples

Migration from user.wallets to user.walletsInfo.

OldQuery
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
query {
  user {
    wallets {
      items {
        id # Referenced as walletId in walletsInfo
        address # subwallet address now has to be retrieved by querying user.subWallets or user.subWallet
        walletType # walletType exposed through user.subWallets or user.subWallet
        name # subwallet name exposed through user.subWallets or user.subWallet
        createdAt # subwallet createdAt exposed through user.subWallets or user.subWallet
        updatedAt # subwallet updatedAt exposed through user.subWallets or user.subWallet
        subWalletId {  # subWalletId exposed through user.subWallets or user.subWallet as a string (subWalletId)
          id
          index
          type
        }
        subWalletIdString  # subWalletId exposed through user.subWallets or user.subWallet as a subWalletId 
      }
    }
  }
}
NewQuery
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
query {
  user {
    walletsInfo{
      items {
        deleted
        walletId
        walletName
        subWalletsSummary {
          subWalletType
          deleted
          count
        }
      }
      nextToken
    }
  }
}

Migration from WalletConnection.allWalletsPortfolio to User.portfolio

OldQuery
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
query {
  user {
    wallets {
      allWalletsPortfolio {
        total {
          **value**
          currency
          timestamp
        }
        balances {
          items {
            amount {
              value
              currency
              ...
            }
            asset {
              name
              symbol
              ...
            }
          }
        }
      }
    }
  }
}
NewQuery
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
query {
  user {
    portfolio {
      items {
        total {
          value
          currency
          timestamp
        }
        balances {
          items {
            amount {
              value
              currency
              ...
            }
            asset {
              displaySymbol
              name
              ...
            }
          }
        }
      }
    }
  }
}