XRP Ledger Apex is back in Amsterdam

Register Now
Documentation
/
References
/
XRP Ledger Protocol Reference
/
Transaction Reference
/
Transaction Types
/
NFTokenCancelOffer
Last updated
Edit

NFTokenCancelOffer

[Source]

The NFTokenCancelOffer transaction can be used to cancel existing token offers created using NFTokenCreateOffer.

(Added by the NonFungibleTokensV1_1 amendment.)

Example NFTokenCancelOffer JSON

{
      "TransactionType": "NFTokenCancelOffer",
      "Account": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
      "NFTokenOffers": [
      "9C92E061381C1EF37A8CDE0E8FC35188BFC30B1883825042A64309AC09F4C36D"
    ]
}

Query example transaction. >

Permissions

An existing offer, represented by an NFTokenOffer object, can be cancelled by:

  • The account that originally created the NFTokenOffer.
  • The account in the Destination field of the NFTokenOffer, if one is present.
  • Any account, if the NFTokenOffer specifies an expiration time and the close time of the parent ledger in which the NFTokenCancelOffer is included is greater than the expiration time.

This transaction removes the listed NFTokenOffer object from the ledger, if present, and adjusts the reserve requirements accordingly. It is not an error if the NFTokenOffer cannot be found: if that is the case, the transaction should complete successfully.

NFTokenCancelOffer Fields

In addition to the common fields, NFTokenCancelOffer transactions use the following fields:

FieldJSON TypeInternal TypeDescription
NFTokenOffersArrayVECTOR256An array of IDs of the NFTokenOffer objects to cancel (not the IDs of NFToken objects, but the IDs of the NFTokenOffer objects). Each entry must be a different object ID of an NFTokenOffer object; the transaction is invalid if the array contains duplicate entries.

The transaction can succeed even if one or more of the IDs in the NFTokenOffers field do not refer to objects that currently exist in the ledger. (For example, those token offers might already have been deleted.) The transaction fails with an error if one of the IDs points to an object that does exist, but is not a NFTokenOffer object.

It is important to note that if you inadvertently provide a nft_id rather than a nft_offer_index, you might receive a tesSUCCESS response. The reason is that when passed a properly formatted ID value that is not found, the system assumes that the NFTokenOffer has already been deleted.

The transaction fails with an error if one of the IDs points to an object that does exist, but is not a NFTokenOffer object.

Error Cases

Besides errors that can occur for all transactions, NFTokenCancelOffer transactions can result in the following transaction result codes:

Error CodeDescription
temDISABLEDThe NonFungibleTokensV1 amendment is not enabled.
temMALFORMEDThe transaction was not validly formatted. For example, the NFTokenOffers array was empty or contained more than the maximum number of offers that can be canceled at one time.
tecNO_PERMISSIONAt least one of the IDs in the NFTokenOffers field refers to an object that cannot be canceled. For example, the sender of this transaction is not the owner or Destination of the offer, or the object was not an NFTokenOffer type object.