Change history

The following table lists the most recent release versions, along with their release date, release type, and end of support date.

For more information about release types, see Release management.

All of the releases listed in this table are all out of support. They are listed for information only.

The following list describes details of deprecated fields and significant updates to fields in each version of the API, along with the deletion date of any deprecations.

• In the following GET operations:

  • List transactions
  • Get transaction details

  The new field ledgerTransactionData.blockTime is deprecated. The approach to block date and time reporting will change in a future release.

• LIST: Events, of type ManifestCreated and ManifestUpdated:
  • New field accountId gives details of the account for which the manifest was created or updated.

• POST: Intent, of type v0_CreateTransactionOrder, for XRPL payments:

  • parameters.destination
  • parameters.destinationTag
  • parameters.amount

  are now deprecated in favor of fields in the new operations section created for tokens.

• POST: Intent, of type v0_CreateAccount: payload.ledgerId is deprecated in favor of payload.ledgerIds to support selection of specific ledgers in multi-ledger accounts.

• GET: Retrieve all generated addresses:
  • The address item details array (items.id, items.ledgerId, items.address, and so on) is now located inside the data array.

• GET: List Users The filter roles has been renamed into roles[] and accepts now an array of strings directly. Multiple arrays can be combined together to realize an OR condition.

• GET: List accounts: additionalDetails.processingStatus is deprecated in favor of additionalDetails.ledgers.ledgerId and additionalDetails.ledgers.status. This is to support compatibility with multi-ledger accounts.
• GET: Get account details: The properties lastBalancesUpdateRequestedAt and lastBalancesUpdateProcessedAt are now located inside the ledger array per each enabled ledger.
• GET: Generate new account external address: This is now deprecated:
  • A new call under the same name is provided where the property ledgerId is now mandatory
• GET: Retrieve latest external address: This is now deprecated. Use Retrieve all generated addresses with the new query parameter lastOnly. We have also provided new query parameter ledgerId and scope.

• GET: id, ledgerId, name, kind, ledgerDetails, symbol, decimal fields are now deprecated:
  • data.* are now available instead

• POST v0_CreateTicker intent:
  • We've introduced v0_ValidateTickers in this version, which allows you to create and validate multiple tickers at once

• POST v0_UpdateEndpoint: ledgerId field:
  • As it is not possible to update ledgerId value of an endpoint, we decided to deprecate this field.

• GET: Recipient address field:
  • Advanced address details are now available in addressDetails payload.
• GET: Senders addresses field:
  • Advanced address details are now available in addressesDetails payload.

• GET: createdBy filter is now deprecated:
  • Use details.author.id and details.author.domainId instead
• POST Approve: expiryAt field is now deprecated:
  • Intent approval and rejections can no longer expire. Use the intent proposal to set the intent expiration instead.
• POST Reject: expiryAt field is now deprecated:
  • Intent approval and rejections can no longer expire. Use the intent proposal to set the intent expiration instead.

• GET: Bitcoin transfer metadata scriptPubKey and address fields:
  • Advanced Bitcoin transaction details are now available in the corresponding transaction's ledgerTransactionData.ledgerData payload, you can correlate the with the transfer output using the new outputIndex field on the Bitcoin transfer metadata.
• GET: Transfer sender field
  • Use senders field instead. There can be 0, 1 or many senders for a transfer. The new array-based senders field covers all of these cases.

• GET: intentTypes filter is now deprecated:
  • Use details.payload.type instead
• GET: status filter is now deprecated::
  • Use state.status instead

• GET: typeInLedger filter is now deprecated:
  • Use kind instead

• GET: transactionOrderId filter is now deprecated:
  • Use orderReference.Id instead