Sign in
Transaction

Preview Transaction

Preview a transaction against the latest network state, and returns the preview receipt. If the node has enabled it, you may be able to also preview against recent network state.

For V2 transactions (and beyond) the /preview-v2 endpoint should be used instead.

This endpoint is effectively a proxy towards the Core API /transaction/preview endpoint. See the Core API documentation for more details.

post/transaction/preview

Request body

manifeststring required

A text-representation of a transaction manifest

blobs_hexstring[]

An array of hex-encoded blob data, if referenced by the manifest.

start_epoch_inclusiveinteger

An integer between 0 and 10^10, marking the epoch at which the transaction startsbeing valid. If omitted, the current epoch will be used.

end_epoch_exclusiveinteger

An integer between 0 and 10^10, marking the epoch at which the transaction is no longer valid. If omitted, a maximum epoch (relative to the start_epoch_inclusive) will be used.

notary_is_signatoryboolean

Whether the notary should be used as a signer (optional). If not provided, this defaults to false.

tip_percentageinteger

An integer between 0 and 65535, giving the validator tip as a percentage amount. A value of 1 corresponds to a 1% fee. If not provided, this defaults to 0.

nonceinteger

An integer between 0 and 2^32 - 1, chosen to allow a unique intent to be created (to enable submitting an otherwise identical/duplicate intent). If not provided, this defaults to 0.

messageobject

An optional transaction message. Only affects the costing. This type is defined in the Core API as TransactionMessage. See the Core API documentation for more details.

Response

Successful Preview

encoded_receiptstring required

Hex-encoded binary blob.

radix_engine_toolkit_receiptobject

An optional field which is only provided if the radix_engine_toolkit_receipt flag is set to true when requesting a transaction preview from the API.

This receipt is primarily intended for use with the toolkit and may contain information that is already available in the receipt provided in the receipt field of this response.

A typical client of this API is not expected to use this receipt. The primary clients this receipt is intended for is the Radix wallet or any client that needs to perform execution summaries on their transactions.

receiptobject required

This type is defined in the Core API as TransactionReceipt. See the Core API documentation for more details.

resource_changesobject[] required

Changes

Changed in 4 of the 50 revisions of this API.19

  • b934f6eb79ca13See the full diff
    • ○

      the request property became optional

      request-property-became-optional

    • ○

      the request property became optional

      request-property-became-optional

    • ○

      the request property / became optional

      request-property-became-optional

    • ○

      the request property / became optional

      request-property-became-optional

    • ○

      the request property / became optional

      request-property-became-optional

    • ○

      the request property became optional

      request-property-became-optional

    • ○

      the request property became optional

      request-property-became-optional

    • ○

      the request property became optional

      request-property-became-optional

    • ○

      the request property became optional

      request-property-became-optional

    • ○

      the request property default value false was added

      request-property-default-value-added

    • ○

      the request property default value false was added

      request-property-default-value-added

    • ○

      the request property default value false was added

      request-property-default-value-added

    • ○

      the request property default value false was added

      request-property-default-value-added

  • 56ef410d77af3See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      response property encoded_receipt deprecated

      response-property-deprecated

  • eb87d151be362See the full diff
    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

  • 7601c23b1af11See the full diff
    • ○

      added AccountLockerNotFoundError discriminator mapping keys to the response property for the response status

      response-property-discriminator-mapping-added