Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

GraphQL API Changes

The GraphQL API has been improved and extended in numerous ways. Here, we mainly highlight the changes that could potentially be breaking for existing API integrations.

Version 8.4.0 changes email configuration, introduces new fiat price support and new asset variants, removes previously deprecated items and introduces new deprecations.

Changes to Configuration

  • The smtpPassword field was removed from EmailConfiguration and EmailConfigurationInput. Configuration queries now expose smtpAuth, and configuration inputs accept smtpAuthSecret. For password authentication, pass smtpAuthSecret: { password: { password: "..." } } instead. The same input also supports Microsoft OAuth 2.0 through the oauth2 variant.

New Fiat Price Support

Transaction detail objects for Email, Offline, TRP (including transactions within your VASP) and TRUST now expose fiatPrices. The AutodMutation.setProviderFiatPrice mutation accepts a transaction ID, a provider name and a TravelFiatPriceInput containing a price and currency. It returns the updated transaction as TravelTx!. Prices from other providers are preserved.

The AutodAuditEvent enum has gained the AUTOD_SET_FIAT_PRICE value for this mutation.

New Asset and Ledger Support

New values were added to Asset, AopdAsset and AopdLedger. The new ledger values are ARBITRUM, AVALANCHE, BASE, BTC_TESTNET3, BTC_TESTNET4, GNOSIS and OPTIMISM.

Removal of deprecated items

  • The previously deprecated proof, proofForAddress, proofForXpub and proofsForCustomer queries on Aopd were removed. Please use the proofs query with a suitable filter argument instead.
  • The previously deprecated proofAsXlsx query on Aopd was removed. Please use proofsAsXlsx with a suitable filter instead. The XLSX file format remains the same.
  • The previously deprecated txDetail and txsWithTxId queries on Autod were removed. Please use txDetails with a suitable filter instead.
  • The previously deprecated txAsXlsx query on Autod was removed. Please use txsAsXlsx with a suitable filter instead. The XLSX file format remains the same.
  • The previously deprecated vasp query on Email was removed. Please use vasps with a suitable filter instead.
  • The previously deprecated status argument to the txDetails, txDetailsCount and txsAsXlsx queries on Autod was removed. Please use the filter argument to select transactions by status instead.
  • The previously deprecated msg input field on AopdExpectedAoppProofInput was removed. Please use message instead.
  • The previously deprecated xpubRequired input field on AopdExpectedAoppProofInput was removed. Please specify the expected address instead. For assets such as Bitcoin, this implicitly requires an xpub and verifies the expected address against it.
  • The previously deprecated ANY and STANDARD values on AopdAddressFormat were removed. Please use null instead.
  • The previously deprecated custodialUser query on Trpd was removed. Please use custodialUsers with a suitable filter instead.
  • The previously deprecated registerCustodialUser and setWalletAddress mutations on TrpdMutation were removed. Please use the mutations with the same names under AutodMutation instead.

New Deprecations

The following items have been deprecated and will be removed in a future release. Please consult the deprecation field for instructions on how to upgrade.

  • The timestampedPrice field on EmailTxDetails, OfflineTxDetails, TrpdIntravaspTxDetails, TrpdSentTxDetails, TrpdTxDetails and TrustdTxDetails. This only supports USD prices from BitMEX. Please use fiatPrices on the transaction instead.
  • The inquire mutation on TrpdMutation. Please use sendTxToAddrOwner under AutodMutation instead.
  • The lookupAddressDirectory query on Trpd. This will be removed without replacement.