Decode

POST /shared-wallets/{walletId}/transactions-decode

status: stable

Decode a serialized transaction, either freshly constructed, partially signed or fully-signed.

Path parameters

walletId string(hex) Required

Minimum length is 40, maximum length is 40.

application/json

Body Required

decrypt_metadata object

The metadata passphrase for decryption.
Hide decrypt_metadata attributes Show decrypt_metadata attributes object
- method string
  
  Value is basic.
- passphrase string Required
  
  A master passphrase to lock and protect the wallet for sensitive operation (e.g. sending funds)
  
  Minimum length is 0, maximum length is 255.
transaction string(base64|base16) Required

The CBOR-encoded transaction, represented in either hex or base64 encoding. This always includes the transaction body and the witness set, even if the latter is empty.

Responses

415 application/json

Unsupported Media Type
Hide response attributes Show response attributes object
- message string Required
  
  May occur when providing an invalid 'Content-Type' header.
- code string Required
  
  Value is unsupported_media_type.
406 application/json

Not Acceptable
Hide response attributes Show response attributes object
- message string Required
  
  May occur when providing an invalid 'Accept' header.
- code string Required
  
  Value is not_acceptable.
404 application/json

Not Found
Hide response attributes Show response attributes object
- message string Required
  
  May occur when a given walletId does not match with any known wallets (because it has been deleted, or has never existed).
- code string Required
  
  Value is no_such_wallet.
- info object
  
  Hide info attribute Show info attribute object
  
  wallet_id string(hex) Required
  
  A unique identifier for the wallet
  
  Minimum length is 40, maximum length is 40.
400 application/json

Bad Request
Hide response attributes Show response attributes object
- message string Required
  
  May occur when a request is not well-formed; that is, it fails to parse successfully. This could be the case when some required parameters are missing or, when malformed values are provided.
- code string Required
  
  Value is bad_request.
403 application/json

Forbidden
Hide response attributes Show response attributes object
- message string Required
  
  The supplied encrypted metadata object is not compatible with standard specified by CIP-83 (https://cips.cardano.org/cip/CIP-83).
- code string Required
  
  Value is invalid_metadata_decryption.
202 application/json

Accepted
Hide response attributes Show response attributes object
- id string(hex) Required
  
  A unique identifier for this transaction
  
  Minimum length is 64, maximum length is 64.
- fee object Required
  
  Coins, in Lovelace. Only relates to 'Ada'. Refer to assets for multi-assets wallets instead.
  
  Hide fee attributes Show fee attributes object
  
  quantity integer Required
  
  Minimum value is 0.
  
  unit string Required
  
  Value is lovelace.
- inputs array[object] Required
  
  Inputs that could be external or belong to the wallet.
  
  At least 0 elements.
  
  One of:
  tx inputs without source not belonging to a given wallet object tx inputs belonging to a given wallet object
  
  A transaction input not belonging to a given wallet.
  
  Hide attributes Show attributes
  
  id string(hex) Required
  
  A unique identifier for this transaction
  
  Minimum length is 64, maximum length is 64.
  
  index integer Required
  
  Minimum value is 0.
  
  A transaction input belonging to a given wallet.
  
  Hide attributes Show attributes
  
  address string(base58|bech32) Required
  
  A sequence of characters that encodes (in Base58 or Bech32) a sequence of bytes which represents an address on the Cardano blockchain. Sequences in Base58 encoding are expected to be legacy Byron addresses, whereas sequences in Bech32 encoding correspond to current Shelley addresses.
  
  For more details, see CIP-0019 — Cardano addresses .
  
  amount object Required
  
  Coins, in Lovelace. Only relates to 'Ada'. Refer to assets for multi-assets wallets instead.
  
  Hide amount attributes Show amount attributes object
  
  quantity integer Required
  
  Minimum value is 0.
  
  unit string Required
  
  Value is lovelace.
  
  assets array[object]
  
  A flat list of assets (possibly empty).
  
  Hide assets attributes Show assets attributes object
  
  policy_id string(hex) Required
  
  A unique identifier of the asset's monetary policy. The policy controls how assets of this kind are created and destroyed.
  
  The contents are the blake2b-224 hash of the monetary policy script, encoded in hexadecimal.
  
  Minimum length is 56, maximum length is 56.
  
  asset_name string(hex) Required
  
  The asset on-chain type which acts as a sub-identifier within a policy. Although we call it "asset name", the value needn't be text, and it could even be empty.
  
  For policies with a single fungible asset item, asset name is typically an empty string.
  
  This value can be up to 32 bytes of arbitrary data (which is 64 hexadecimal digits).
  
  Maximum length is 64.
  
  quantity integer Required
  
  Number of assets for the given policy_id and asset_name.
  
  Minimum value is 0.
  
  id string(hex) Required
  
  A unique identifier for this transaction
  
  Minimum length is 64, maximum length is 64.
  
  derivation_path array[string] Required
  
  An individual segment within a derivation path.
  
  The H suffix indicates a Hardened child private key, which means that children of this key cannot be derived from the public key. Indices without a H suffix are called Soft.
  
  At least 1 element.
  
  index integer Required
  
  Minimum value is 0.
- outputs array[object] Required
  
  Outputs that could be external or belong to the wallet.
  
  At least 0 elements.
  
  One of:
  tx outputs not belonging to a given wallet object tx outputs belonging to a given wallet object
  
  A transaction output not belonging to the wallet
  
  Hide attributes Show attributes
  
  address string(base58|bech32) Required
  
  A sequence of characters that encodes (in Base58 or Bech32) a sequence of bytes which represents an address on the Cardano blockchain. Sequences in Base58 encoding are expected to be legacy Byron addresses, whereas sequences in Bech32 encoding correspond to current Shelley addresses.
  
  For more details, see CIP-0019 — Cardano addresses .
  
  amount object Required
  
  Coins, in Lovelace. Only relates to 'Ada'. Refer to assets for multi-assets wallets instead.
  
  Hide amount attributes Show amount attributes object
  
  quantity integer Required
  
  Minimum value is 0.
  
  unit string Required
  
  Value is lovelace.
  
  assets array[object]
  
  A flat list of assets (possibly empty).
  
  Hide assets attributes Show assets attributes object
  
  policy_id string(hex) Required
  
  A unique identifier of the asset's monetary policy. The policy controls how assets of this kind are created and destroyed.
  
  The contents are the blake2b-224 hash of the monetary policy script, encoded in hexadecimal.
  
  Minimum length is 56, maximum length is 56.
  
  asset_name string(hex) Required
  
  The asset on-chain type which acts as a sub-identifier within a policy. Although we call it "asset name", the value needn't be text, and it could even be empty.
  
  For policies with a single fungible asset item, asset name is typically an empty string.
  
  This value can be up to 32 bytes of arbitrary data (which is 64 hexadecimal digits).
  
  Maximum length is 64.
  
  quantity integer Required
  
  Number of assets for the given policy_id and asset_name.
  
  Minimum value is 0.
  
  A transaction output not belonging to the wallet
  
  Hide attributes Show attributes
  
  address string(base58|bech32) Required
  
  A sequence of characters that encodes (in Base58 or Bech32) a sequence of bytes which represents an address on the Cardano blockchain. Sequences in Base58 encoding are expected to be legacy Byron addresses, whereas sequences in Bech32 encoding correspond to current Shelley addresses.
  
  For more details, see CIP-0019 — Cardano addresses .
  
  amount object Required
  
  Coins, in Lovelace. Only relates to 'Ada'. Refer to assets for multi-assets wallets instead.
  
  Hide amount attributes Show amount attributes object
  
  quantity integer Required
  
  Minimum value is 0.
  
  unit string Required
  
  Value is lovelace.
  
  assets array[object]
  
  A flat list of assets (possibly empty).
  
  Hide assets attributes Show assets attributes object
  
  policy_id string(hex) Required
  
  A unique identifier of the asset's monetary policy. The policy controls how assets of this kind are created and destroyed.
  
  The contents are the blake2b-224 hash of the monetary policy script, encoded in hexadecimal.
  
  Minimum length is 56, maximum length is 56.
  
  asset_name string(hex) Required
  
  The asset on-chain type which acts as a sub-identifier within a policy. Although we call it "asset name", the value needn't be text, and it could even be empty.
  
  For policies with a single fungible asset item, asset name is typically an empty string.
  
  This value can be up to 32 bytes of arbitrary data (which is 64 hexadecimal digits).
  
  Maximum length is 64.
  
  quantity integer Required
  
  Number of assets for the given policy_id and asset_name.
  
  Minimum value is 0.
  
  derivation_path array[string] Required
  
  An individual segment within a derivation path.
  
  The H suffix indicates a Hardened child private key, which means that children of this key cannot be derived from the public key. Indices without a H suffix are called Soft.
  
  At least 1 element.
- collateral array[object]
  
  Inputs that could be external or belong to the wallet.
  
  At least 0 elements.
  
  One of:
  tx inputs without source not belonging to a given wallet object tx inputs belonging to a given wallet object
  
  A transaction input not belonging to a given wallet.
  
  Hide attributes Show attributes
  
  id string(hex) Required
  
  A unique identifier for this transaction
  
  Minimum length is 64, maximum length is 64.
  
  index integer Required
  
  Minimum value is 0.
  
  A transaction input belonging to a given wallet.
  
  Hide attributes Show attributes
  
  address string(base58|bech32) Required
  
  A sequence of characters that encodes (in Base58 or Bech32) a sequence of bytes which represents an address on the Cardano blockchain. Sequences in Base58 encoding are expected to be legacy Byron addresses, whereas sequences in Bech32 encoding correspond to current Shelley addresses.
  
  For more details, see CIP-0019 — Cardano addresses .
  
  amount object Required
  
  Coins, in Lovelace. Only relates to 'Ada'. Refer to assets for multi-assets wallets instead.
  
  Hide amount attributes Show amount attributes object
  
  quantity integer Required
  
  Minimum value is 0.
  
  unit string Required
  
  Value is lovelace.
  
  assets array[object]
  
  A flat list of assets (possibly empty).
  
  Hide assets attributes Show assets attributes object
  
  policy_id string(hex) Required
  
  A unique identifier of the asset's monetary policy. The policy controls how assets of this kind are created and destroyed.
  
  The contents are the blake2b-224 hash of the monetary policy script, encoded in hexadecimal.
  
  Minimum length is 56, maximum length is 56.
  
  asset_name string(hex) Required
  
  The asset on-chain type which acts as a sub-identifier within a policy. Although we call it "asset name", the value needn't be text, and it could even be empty.
  
  For policies with a single fungible asset item, asset name is typically an empty string.
  
  This value can be up to 32 bytes of arbitrary data (which is 64 hexadecimal digits).
  
  Maximum length is 64.
  
  quantity integer Required
  
  Number of assets for the given policy_id and asset_name.
  
  Minimum value is 0.
  
  id string(hex) Required
  
  A unique identifier for this transaction
  
  Minimum length is 64, maximum length is 64.
  
  derivation_path array[string] Required
  
  An individual segment within a derivation path.
  
  The H suffix indicates a Hardened child private key, which means that children of this key cannot be derived from the public key. Indices without a H suffix are called Soft.
  
  At least 1 element.
  
  index integer Required
  
  Minimum value is 0.
- collateral_outputs array[object]
  
  Outputs that could be external or belong to the wallet.
  
  At least 0 but not more than 1 element.
  
  One of:
  tx outputs not belonging to a given wallet object tx outputs belonging to a given wallet object
  
  A transaction output not belonging to the wallet
  
  Hide attributes Show attributes
  
  address string(base58|bech32) Required
  
  A sequence of characters that encodes (in Base58 or Bech32) a sequence of bytes which represents an address on the Cardano blockchain. Sequences in Base58 encoding are expected to be legacy Byron addresses, whereas sequences in Bech32 encoding correspond to current Shelley addresses.
  
  For more details, see CIP-0019 — Cardano addresses .
  
  amount object Required
  
  Coins, in Lovelace. Only relates to 'Ada'. Refer to assets for multi-assets wallets instead.
  
  Hide amount attributes Show amount attributes object
  
  quantity integer Required
  
  Minimum value is 0.
  
  unit string Required
  
  Value is lovelace.
  
  assets array[object]
  
  A flat list of assets (possibly empty).
  
  Hide assets attributes Show assets attributes object
  
  policy_id string(hex) Required
  
  A unique identifier of the asset's monetary policy. The policy controls how assets of this kind are created and destroyed.
  
  The contents are the blake2b-224 hash of the monetary policy script, encoded in hexadecimal.
  
  Minimum length is 56, maximum length is 56.
  
  asset_name string(hex) Required
  
  The asset on-chain type which acts as a sub-identifier within a policy. Although we call it "asset name", the value needn't be text, and it could even be empty.
  
  For policies with a single fungible asset item, asset name is typically an empty string.
  
  This value can be up to 32 bytes of arbitrary data (which is 64 hexadecimal digits).
  
  Maximum length is 64.
  
  quantity integer Required
  
  Number of assets for the given policy_id and asset_name.
  
  Minimum value is 0.
  
  A transaction output not belonging to the wallet
  
  Hide attributes Show attributes
  
  address string(base58|bech32) Required
  
  A sequence of characters that encodes (in Base58 or Bech32) a sequence of bytes which represents an address on the Cardano blockchain. Sequences in Base58 encoding are expected to be legacy Byron addresses, whereas sequences in Bech32 encoding correspond to current Shelley addresses.
  
  For more details, see CIP-0019 — Cardano addresses .
  
  amount object Required
  
  Coins, in Lovelace. Only relates to 'Ada'. Refer to assets for multi-assets wallets instead.
  
  Hide amount attributes Show amount attributes object
  
  quantity integer Required
  
  Minimum value is 0.
  
  unit string Required
  
  Value is lovelace.
  
  assets array[object]
  
  A flat list of assets (possibly empty).
  
  Hide assets attributes Show assets attributes object
  
  policy_id string(hex) Required
  
  A unique identifier of the asset's monetary policy. The policy controls how assets of this kind are created and destroyed.
  
  The contents are the blake2b-224 hash of the monetary policy script, encoded in hexadecimal.
  
  Minimum length is 56, maximum length is 56.
  
  asset_name string(hex) Required
  
  The asset on-chain type which acts as a sub-identifier within a policy. Although we call it "asset name", the value needn't be text, and it could even be empty.
  
  For policies with a single fungible asset item, asset name is typically an empty string.
  
  This value can be up to 32 bytes of arbitrary data (which is 64 hexadecimal digits).
  
  Maximum length is 64.
  
  quantity integer Required
  
  Number of assets for the given policy_id and asset_name.
  
  Minimum value is 0.
  
  derivation_path array[string] Required
  
  An individual segment within a derivation path.
  
  The H suffix indicates a Hardened child private key, which means that children of this key cannot be derived from the public key. Indices without a H suffix are called Soft.
  
  At least 1 element.
- withdrawals array[object] Required
  
  Withdrawals that could be external or belong to the wallet.
  
  At least 0 elements.
  
  Hide withdrawals attributes Show withdrawals attributes object
  
  stake_address string(bech32) Required
  
  amount object Required
  
  Coins, in Lovelace. Only relates to 'Ada'. Refer to assets for multi-assets wallets instead.
  
  Hide amount attributes Show amount attributes object
  
  quantity integer Required
  
  Minimum value is 0.
  
  unit string Required
  
  Value is lovelace.
  
  context string
  
  Used when withdrawal or output is ours.
  
  Value is ours.
  
  Additional properties are NOT allowed
- mint object Required
  
  Hide mint attributes Show mint attributes object
  
  tokens array[object] Required
  
  At least 0 elements.
  
  Hide tokens attributes Show tokens attributes object
  
  policy_id string(hex) Required
  
  A unique identifier of the asset's monetary policy. The policy controls how assets of this kind are created and destroyed.
  
  The contents are the blake2b-224 hash of the monetary policy script, encoded in hexadecimal.
  
  Minimum length is 56, maximum length is 56.
  
  policy_script object Required
  
  One of:
  native script object plutus script object reference script object
  
  Hide attributes Show attributes
  
  script_type string Required
  
  Value is native.
  
  script string(bech32) | object Required
  
  One of:
  Key Hash string(bech32) All object Any object Some object Active from slot object Active until slot object
  
  Leaf value for a script designating a required verification key hash.
  
  Format should match the following pattern: ^((addr_shared_vkh)|(stake_shared_vkh)|(policy_vkh))1[0-9a-z]*$.
  
  Hide attribute Show attribute
  
  all array[string(bech32) | object] Required
  
  Script primitive for which all signing keys corresponding to all list elements' verification keys are expected to make the script valid.
  
  At least 1 element.
  
  One of:
  Key Hash string(bech32) All object Any object Some object Active from slot object Active until slot object
  
  Leaf value for a script designating a required verification key hash.
  
  Format should match the following pattern: ^((addr_shared_vkh)|(stake_shared_vkh)|(policy_vkh))1[0-9a-z]*$.
  
  Hide attribute Show attribute
  
  some object Required
  
  Script primitive for which at least a given number of signing keys corresponding to the list elements' verification keys are expected to make the script valid.
  
  Hide some attributes Show some attributes object
  
  at_least integer Required
  
  Minimum value is 1, maximum value is 255.
  
  from array Required
  
  At least 1 element.
  
  Hide attribute Show attribute
  
  any array[string(bech32) | object] Required
  
  Script primitive for which a signing key corresponding to any of the list elements' verification keys is expected to make the script valid. It is equivalent to some with "at_least"=1.
  
  At least 1 element.
  
  One of:
  Key Hash string(bech32) All object Any object Some object Active from slot object Active until slot object
  
  Leaf value for a script designating a required verification key hash.
  
  Format should match the following pattern: ^((addr_shared_vkh)|(stake_shared_vkh)|(policy_vkh))1[0-9a-z]*$.
  
  Hide attribute Show attribute
  
  some object Required
  
  Script primitive for which at least a given number of signing keys corresponding to the list elements' verification keys are expected to make the script valid.
  
  Hide some attributes Show some attributes object
  
  at_least integer Required
  
  Minimum value is 1, maximum value is 255.
  
  from array Required
  
  At least 1 element.
  
  Hide attribute Show attribute
  
  some object Required
  
  Script primitive for which at least a given number of signing keys corresponding to the list elements' verification keys are expected to make the script valid.
  
  Hide some attributes Show some attributes object
  
  at_least integer Required
  
  Minimum value is 1, maximum value is 255.
  
  from array[string(bech32) | object] Required
  
  At least 1 element.
  
  One of:
  Key Hash string(bech32) All object Any object Some object Active from slot object Active until slot object
  
  Leaf value for a script designating a required verification key hash.
  
  Format should match the following pattern: ^((addr_shared_vkh)|(stake_shared_vkh)|(policy_vkh))1[0-9a-z]*$.
  
  Hide attribute Show attribute
  
  some object Required
  
  Script primitive for which at least a given number of signing keys corresponding to the list elements' verification keys are expected to make the script valid.
  
  Hide some attributes Show some attributes object
  
  at_least integer Required
  
  Minimum value is 1, maximum value is 255.
  
  from array Required
  
  At least 1 element.
  
  reference object
  
  A reference input.
  
  Hide reference attributes Show reference attributes object
  
  id string(hex) Required
  
  A unique identifier for this transaction
  
  Minimum length is 64, maximum length is 64.
  
  index integer Required
  
  Minimum value is 0.
  
  Hide attributes Show attributes
  
  script_type string Required
  
  Value is plutus.
  
  script_info object Required
  
  Hide script_info attributes Show script_info attributes object
  
  language_version string Required
  
  Values are v1 or v2.
  
  script_hash string(hex) Required
  
  Minimum length is 56, maximum length is 56.
  
  reference object
  
  A reference input.
  
  Hide reference attributes Show reference attributes object
  
  id string(hex) Required
  
  A unique identifier for this transaction
  
  Minimum length is 64, maximum length is 64.
  
  index integer Required
  
  Minimum value is 0.
  
  Hide attributes Show attributes
  
  script_type string Required
  
  Value is reference script.
  
  script_hash string(hex) Required
  
  Minimum length is 56, maximum length is 56.
  
  references array[object] Required
  
  At least 1 element.
  
  Hide references attributes Show references attributes object
  
  id string(hex) Required
  
  A unique identifier for this transaction
  
  Minimum length is 64, maximum length is 64.
  
  index integer Required
  
  Minimum value is 0.
  
  assets array[object] Required
  
  At least 1 element.
  
  Hide assets attributes Show assets attributes object
  
  asset_name string(hex) Required
  
  The asset on-chain type which acts as a sub-identifier within a policy. Although we call it "asset name", the value needn't be text, and it could even be empty.
  
  For policies with a single fungible asset item, asset name is typically an empty string.
  
  This value can be up to 32 bytes of arbitrary data (which is 64 hexadecimal digits).
  
  Maximum length is 64.
  
  quantity integer Required
  
  Number of assets for the given policy_id and asset_name.
  
  Minimum value is 0.
  
  fingerprint string Required
  
  A user-facing short fingerprint which combines the policy_id and asset_name to allow for an easier human comparison of assets. Note that it is generally not okay to use this fingerprint as a unique identifier for it is not collision resistant. Yet within the context of a single wallet, it makes for a (rather) short user-facing comparison mean.
  
  Minimum length is 44, maximum length is 44. Format should match the following pattern: ^(asset)1[0-9a-z]*$.
  
  wallet_policy_key_hash string(bech32)
  
  Format should match the following pattern: ^((policy_vk)|(policy_vkh))1[0-9a-z]*$.
  
  wallet_policy_key_index string
  
  An individual segment within a derivation path.
  
  The H suffix indicates a Hardened child private key, which means that children of this key cannot be derived from the public key. Indices without a H suffix are called Soft.
- burn object Required
  
  Hide burn attributes Show burn attributes object
  
  tokens array[object] Required
  
  At least 0 elements.
  
  Hide tokens attributes Show tokens attributes object
  
  policy_id string(hex) Required
  
  A unique identifier of the asset's monetary policy. The policy controls how assets of this kind are created and destroyed.
  
  The contents are the blake2b-224 hash of the monetary policy script, encoded in hexadecimal.
  
  Minimum length is 56, maximum length is 56.
  
  policy_script object Required
  
  One of:
  native script object plutus script object reference script object
  
  Hide attributes Show attributes
  
  script_type string Required
  
  Value is native.
  
  script string(bech32) | object Required
  
  One of:
  Key Hash string(bech32) All object Any object Some object Active from slot object Active until slot object
  
  Leaf value for a script designating a required verification key hash.
  
  Format should match the following pattern: ^((addr_shared_vkh)|(stake_shared_vkh)|(policy_vkh))1[0-9a-z]*$.
  
  Hide attribute Show attribute
  
  all array[string(bech32) | object] Required
  
  Script primitive for which all signing keys corresponding to all list elements' verification keys are expected to make the script valid.
  
  At least 1 element.
  
  One of:
  Key Hash string(bech32) All object Any object Some object Active from slot object Active until slot object
  
  Leaf value for a script designating a required verification key hash.
  
  Format should match the following pattern: ^((addr_shared_vkh)|(stake_shared_vkh)|(policy_vkh))1[0-9a-z]*$.
  
  Hide attribute Show attribute
  
  some object Required
  
  Script primitive for which at least a given number of signing keys corresponding to the list elements' verification keys are expected to make the script valid.
  
  Hide some attributes Show some attributes object
  
  at_least integer Required
  
  Minimum value is 1, maximum value is 255.
  
  from array Required
  
  At least 1 element.
  
  Hide attribute Show attribute
  
  any array[string(bech32) | object] Required
  
  Script primitive for which a signing key corresponding to any of the list elements' verification keys is expected to make the script valid. It is equivalent to some with "at_least"=1.
  
  At least 1 element.
  
  One of:
  Key Hash string(bech32) All object Any object Some object Active from slot object Active until slot object
  
  Leaf value for a script designating a required verification key hash.
  
  Format should match the following pattern: ^((addr_shared_vkh)|(stake_shared_vkh)|(policy_vkh))1[0-9a-z]*$.
  
  Hide attribute Show attribute
  
  some object Required
  
  Script primitive for which at least a given number of signing keys corresponding to the list elements' verification keys are expected to make the script valid.
  
  Hide some attributes Show some attributes object
  
  at_least integer Required
  
  Minimum value is 1, maximum value is 255.
  
  from array Required
  
  At least 1 element.
  
  Hide attribute Show attribute
  
  some object Required
  
  Script primitive for which at least a given number of signing keys corresponding to the list elements' verification keys are expected to make the script valid.
  
  Hide some attributes Show some attributes object
  
  at_least integer Required
  
  Minimum value is 1, maximum value is 255.
  
  from array[string(bech32) | object] Required
  
  At least 1 element.
  
  One of:
  Key Hash string(bech32) All object Any object Some object Active from slot object Active until slot object
  
  Leaf value for a script designating a required verification key hash.
  
  Format should match the following pattern: ^((addr_shared_vkh)|(stake_shared_vkh)|(policy_vkh))1[0-9a-z]*$.
  
  Hide attribute Show attribute
  
  some object Required
  
  Script primitive for which at least a given number of signing keys corresponding to the list elements' verification keys are expected to make the script valid.
  
  Hide some attributes Show some attributes object
  
  at_least integer Required
  
  Minimum value is 1, maximum value is 255.
  
  from array Required
  
  At least 1 element.
  
  reference object
  
  A reference input.
  
  Hide reference attributes Show reference attributes object
  
  id string(hex) Required
  
  A unique identifier for this transaction
  
  Minimum length is 64, maximum length is 64.
  
  index integer Required
  
  Minimum value is 0.
  
  Hide attributes Show attributes
  
  script_type string Required
  
  Value is plutus.
  
  script_info object Required
  
  Hide script_info attributes Show script_info attributes object
  
  language_version string Required
  
  Values are v1 or v2.
  
  script_hash string(hex) Required
  
  Minimum length is 56, maximum length is 56.
  
  reference object
  
  A reference input.
  
  Hide reference attributes Show reference attributes object
  
  id string(hex) Required
  
  A unique identifier for this transaction
  
  Minimum length is 64, maximum length is 64.
  
  index integer Required
  
  Minimum value is 0.
  
  Hide attributes Show attributes
  
  script_type string Required
  
  Value is reference script.
  
  script_hash string(hex) Required
  
  Minimum length is 56, maximum length is 56.
  
  references array[object] Required
  
  At least 1 element.
  
  Hide references attributes Show references attributes object
  
  id string(hex) Required
  
  A unique identifier for this transaction
  
  Minimum length is 64, maximum length is 64.
  
  index integer Required
  
  Minimum value is 0.
  
  assets array[object] Required
  
  At least 1 element.
  
  Hide assets attributes Show assets attributes object
  
  asset_name string(hex) Required
  
  The asset on-chain type which acts as a sub-identifier within a policy. Although we call it "asset name", the value needn't be text, and it could even be empty.
  
  For policies with a single fungible asset item, asset name is typically an empty string.
  
  This value can be up to 32 bytes of arbitrary data (which is 64 hexadecimal digits).
  
  Maximum length is 64.
  
  quantity integer Required
  
  Number of assets for the given policy_id and asset_name.
  
  Minimum value is 0.
  
  fingerprint string Required
  
  A user-facing short fingerprint which combines the policy_id and asset_name to allow for an easier human comparison of assets. Note that it is generally not okay to use this fingerprint as a unique identifier for it is not collision resistant. Yet within the context of a single wallet, it makes for a (rather) short user-facing comparison mean.
  
  Minimum length is 44, maximum length is 44. Format should match the following pattern: ^(asset)1[0-9a-z]*$.
  
  wallet_policy_key_hash string(bech32)
  
  Format should match the following pattern: ^((policy_vk)|(policy_vkh))1[0-9a-z]*$.
  
  wallet_policy_key_index string
  
  An individual segment within a derivation path.
  
  The H suffix indicates a Hardened child private key, which means that children of this key cannot be derived from the public key. Indices without a H suffix are called Soft.
- certificates array[object] Required
  
  At least 0 elements.
  
  Any certificate that could occur in an arbitrary transaction: might be related to delegation, pool activities, genesis or MIR.
  
  One of:
  delegation certificate belonging to the wallet object delegation certificate not belonging to the wallet object pool registration certificate object pool deregistration certificate object genesis or MIR certificate object
  
  A delegation certificate belonging to wallet
  
  Only for 'join_pool' the 'pool' property is required.
  
  Hide attributes Show attributes
  
  certificate_type string Required
  
  Values are join_pool, quit_pool, or register_reward_account.
  
  pool string(hex|bech32)
  
  A unique identifier for the pool.
  
  reward_account_path array[string] Required
  
  At least 5 but not more than 5 elements.
  
  A delegation certificate not belonging to wallet
  
  Only for 'join_pool' the 'pool' property is required.
  
  Hide attributes Show attributes
  
  certificate_type string Required
  
  Values are join_pool_external, quit_pool_external, or register_reward_account_external.
  
  pool string(hex|bech32)
  
  A unique identifier for the pool.
  
  reward_account string(bech32) Required
  
  Hide attributes Show attributes
  
  certificate_type string Required
  
  Value is register_pool.
  
  pool_id string(hex|bech32) Required
  
  A unique identifier for the pool.
  
  pool_owners array[string(bech32)] Required
  
  At least 0 elements. Format of each should match the following pattern: ^(ed25519_pk)1[0-9a-z]*$.
  
  pool_margin object Required
  
  Variable margin on the total reward given to an operator before splitting rewards between stakeholders.
  
  May be omitted if the wallet hasn't found the pool's registration cerificate yet.
  
  Hide pool_margin attributes Show pool_margin attributes object
  
  quantity number Required
  
  Minimum value is 0, maximum value is 100.
  
  unit string Required
  
  Value is percent.
  
  pool_cost object Required
  
  Estimated cost set by the pool operator when registering his pool. This fixed cost is taken from each reward earned by the pool before splitting rewards between stakeholders.
  
  May be omitted if the wallet hasn't found the pool's registration cerificate yet.
  
  Hide pool_cost attributes Show pool_cost attributes object
  
  quantity integer Required
  
  Minimum value is 0.
  
  unit string Required
  
  Value is lovelace.
  
  pool_pledge object Required
  
  Minimal stake amount that a stake pool is willing to honor.
  
  May be omitted if the wallet hasn't found the pool's registration cerificate yet.
  
  Hide pool_pledge attributes Show pool_pledge attributes object
  
  quantity integer Required
  
  Minimum value is 0.
  
  unit string Required
  
  Value is lovelace.
  
  pool_metadata object
  
  Hide pool_metadata attributes Show pool_metadata attributes object
  
  url string(uri) Required
  
  A URL to the stake pool's website.
  
  Maximum length is 250. Format should match the following pattern: ^https://.+.
  
  hash string(hex) Required
  
  Minimum length is 64, maximum length is 64.
  
  Hide attributes Show attributes
  
  certificate_type string Required
  
  Value is deregister_pool.
  
  pool_id string(hex|bech32) Required
  
  A unique identifier for the pool.
  
  retirement_epoch integer Required
  
  An epoch is a time period which is divided into slots.
  
  Minimum value is 0.
- metadata object | null
  
  ⚠️ WARNING ⚠️
  
  Please note that metadata provided in a transaction will be stored on the blockchain forever. Make sure not to include any sensitive data, in particular personally identifiable information (PII).
  
  Extra application data attached to the transaction.
  
  Cardano allows users and developers to embed their own authenticated metadata when submitting transactions. Metadata can be expressed as a JSON object with some restrictions:
  
  All top-level keys must be integers between 0 and 2^64 - 1.
  
  Each metadata value is tagged with its type.
  
  Strings must be at most 64 bytes when UTF-8 encoded.
  
  Bytestrings are hex-encoded, with a maximum length of 64 bytes.
  
  Metadata aren't stored as JSON on the Cardano blockchain but are instead stored using a compact binary encoding (CBOR).
  
  The binary encoding of metadata values supports three simple types:
  
  Integers in the range -(2^64 - 1) to 2^64 - 1
  
  Strings (UTF-8 encoded)
  
  Bytestrings
  
  And two compound types:
  
  Lists of metadata values
  
  Mappings from metadata values to metadata values
  
  It is possible to transform any JSON object into this schema.
  
  However, if your application uses floating point values, they will need to be converted somehow, according to your requirements. Likewise for null or bool values. When reading metadata from chain, be aware that integers may exceed the javascript numeric range, and may need special "bigint" parsing.
  
  Any of:
  full object | null simple object | null
- deposits_taken array[object]
  
  A list of deposits associated with a transaction.
  
  At least 0 elements.
  
  Hide deposits_taken attributes Show deposits_taken attributes object
  
  quantity integer Required
  
  Minimum value is 0.
  
  unit string Required
  
  Value is lovelace.
- deposits_returned array[object]
  
  A list of deposits associated with a transaction.
  
  At least 0 elements.
  
  Hide deposits_returned attributes Show deposits_returned attributes object
  
  quantity integer Required
  
  Minimum value is 0.
  
  unit string Required
  
  Value is lovelace.
- script_validity string | null
  
  Indicates whether the phase-2 monetary policy script (e.g. Plutus script) used in the transaction validated or not. Validity may be null if this transaction was from an era that doesn't support phase-2 monetary policy scripts, or is a pending transaction (we don't know if validation passed or failed until the transaction hits the ledger).
  
  Values are valid or invalid.
- validity_interval object
  
  Hide validity_interval attributes Show validity_interval attributes object
  
  invalid_before object Required
  
  Hide invalid_before attributes Show invalid_before attributes object
  
  quantity integer Required
  
  Minimum value is 0.
  
  unit string Required
  
  Value is slot.
  
  invalid_hereafter object Required
  
  Hide invalid_hereafter attributes Show invalid_hereafter attributes object
  
  quantity integer Required
  
  Minimum value is 0.
  
  unit string Required
  
  Value is slot.
- witness_count object Required
  
  Specifies the number of verification key and bootstrap wintesses. As scripts act as witnesses they are also included. Scripts can be specified and spent in a given transaction or defined to be consumed later. In the latter case they are defined in transaction outputs (feature possible from Babbage era) in one transaction and referenced in other later transaction(s). The script referencing is realized via including of reference in a reference input. If reference script is present here it included the form of the script and reference to be used later, ie. tx id and index of tx out where the script was included.
  
  Hide witness_count attributes Show witness_count attributes object
  
  verification_key integer Required
  
  The number of witnesses detected
  
  Minimum value is 0, maximum value is 127.
  
  scripts array[object] Required
  
  At least 0 elements.
  
  One of:
  native script object plutus script object
  
  Hide attributes Show attributes
  
  script_type string Required
  
  Value is native.
  
  script string(bech32) | object Required
  
  One of:
  Key Hash string(bech32) All object Any object Some object Active from slot object Active until slot object
  
  Leaf value for a script designating a required verification key hash.
  
  Format should match the following pattern: ^((addr_shared_vkh)|(stake_shared_vkh)|(policy_vkh))1[0-9a-z]*$.
  
  Hide attribute Show attribute
  
  all array[string(bech32) | object] Required
  
  Script primitive for which all signing keys corresponding to all list elements' verification keys are expected to make the script valid.
  
  At least 1 element.
  
  One of:
  Key Hash string(bech32) All object Any object Some object Active from slot object Active until slot object
  
  Leaf value for a script designating a required verification key hash.
  
  Format should match the following pattern: ^((addr_shared_vkh)|(stake_shared_vkh)|(policy_vkh))1[0-9a-z]*$.
  
  Hide attribute Show attribute
  
  some object Required
  
  Script primitive for which at least a given number of signing keys corresponding to the list elements' verification keys are expected to make the script valid.
  
  Hide some attributes Show some attributes object
  
  at_least integer Required
  
  Minimum value is 1, maximum value is 255.
  
  from array Required
  
  At least 1 element.
  
  Hide attribute Show attribute
  
  any array[string(bech32) | object] Required
  
  Script primitive for which a signing key corresponding to any of the list elements' verification keys is expected to make the script valid. It is equivalent to some with "at_least"=1.
  
  At least 1 element.
  
  One of:
  Key Hash string(bech32) All object Any object Some object Active from slot object Active until slot object
  
  Leaf value for a script designating a required verification key hash.
  
  Format should match the following pattern: ^((addr_shared_vkh)|(stake_shared_vkh)|(policy_vkh))1[0-9a-z]*$.
  
  Hide attribute Show attribute
  
  some object Required
  
  Script primitive for which at least a given number of signing keys corresponding to the list elements' verification keys are expected to make the script valid.
  
  Hide some attributes Show some attributes object
  
  at_least integer Required
  
  Minimum value is 1, maximum value is 255.
  
  from array Required
  
  At least 1 element.
  
  Hide attribute Show attribute
  
  some object Required
  
  Script primitive for which at least a given number of signing keys corresponding to the list elements' verification keys are expected to make the script valid.
  
  Hide some attributes Show some attributes object
  
  at_least integer Required
  
  Minimum value is 1, maximum value is 255.
  
  from array[string(bech32) | object] Required
  
  At least 1 element.
  
  One of:
  Key Hash string(bech32) All object Any object Some object Active from slot object Active until slot object
  
  Leaf value for a script designating a required verification key hash.
  
  Format should match the following pattern: ^((addr_shared_vkh)|(stake_shared_vkh)|(policy_vkh))1[0-9a-z]*$.
  
  Hide attribute Show attribute
  
  some object Required
  
  Script primitive for which at least a given number of signing keys corresponding to the list elements' verification keys are expected to make the script valid.
  
  Hide some attributes Show some attributes object
  
  at_least integer Required
  
  Minimum value is 1, maximum value is 255.
  
  from array Required
  
  At least 1 element.
  
  reference object
  
  A reference input.
  
  Hide reference attributes Show reference attributes object
  
  id string(hex) Required
  
  A unique identifier for this transaction
  
  Minimum length is 64, maximum length is 64.
  
  index integer Required
  
  Minimum value is 0.
  
  Hide attributes Show attributes
  
  script_type string Required
  
  Value is plutus.
  
  script_info object Required
  
  Hide script_info attributes Show script_info attributes object
  
  language_version string Required
  
  Values are v1 or v2.
  
  script_hash string(hex) Required
  
  Minimum length is 56, maximum length is 56.
  
  reference object
  
  A reference input.
  
  Hide reference attributes Show reference attributes object
  
  id string(hex) Required
  
  A unique identifier for this transaction
  
  Minimum length is 64, maximum length is 64.
  
  index integer Required
  
  Minimum value is 0.
  
  bootstrap integer Required
  
  The number of witnesses detected
  
  Minimum value is 0, maximum value is 127.

POST /shared-wallets/{walletId}/transactions-decode

curl \
 --request POST https://localhost:8090/v2/shared-wallets/{walletId}/transactions-decode \
 --header "Content-Type: application/json" \
 --data '{"decrypt_metadata":{"method":"basic","passphrase":"Secure Passphrase"},"transaction":"string"}'

Request examples

{
  "decrypt_metadata": {
    "method": "basic",
    "passphrase": "Secure Passphrase"
  },
  "transaction": "string"
}

Response examples (415)

{
  "message": "string",
  "code": "unsupported_media_type"
}

Response examples (406)

{
  "message": "string",
  "code": "not_acceptable"
}

Response examples (404)

{
  "message": "string",
  "code": "no_such_wallet",
  "info": {
    "wallet_id": "2512a00e9653fe49a44a5886202e24d77eeb998f"
  }
}

Response examples (400)

{
  "message": "string",
  "code": "bad_request"
}

Response examples (403)

{
  "message": "string",
  "code": "invalid_metadata_decryption"
}

Response examples (202)

{
  "id": "1423856bc91c49e928f6f30f4e8d665d53eb4ab6028bd0ac971809d514c92db1",
  "fee": {
    "quantity": 42000000,
    "unit": "lovelace"
  },
  "inputs": [
    {
      "id": "1423856bc91c49e928f6f30f4e8d665d53eb4ab6028bd0ac971809d514c92db1",
      "index": 42
    }
  ],
  "outputs": [
    {
      "address": "addr1sjck9mdmfyhzvjhydcjllgj9vjvl522w0573ncustrrr2rg7h9azg4cyqd36yyd48t5ut72hgld0fg2xfvz82xgwh7wal6g2xt8n996s3xvu5g",
      "amount": {
        "quantity": 42000000,
        "unit": "lovelace"
      },
      "assets": [
        {
          "policy_id": "65ab82542b0ca20391caaf66a4d4d7897d281f9c136cd3513136945b",
          "asset_name": "string",
          "quantity": 42
        }
      ]
    }
  ],
  "collateral": [
    {
      "id": "1423856bc91c49e928f6f30f4e8d665d53eb4ab6028bd0ac971809d514c92db1",
      "index": 42
    }
  ],
  "collateral_outputs": [
    {
      "address": "addr1sjck9mdmfyhzvjhydcjllgj9vjvl522w0573ncustrrr2rg7h9azg4cyqd36yyd48t5ut72hgld0fg2xfvz82xgwh7wal6g2xt8n996s3xvu5g",
      "amount": {
        "quantity": 42000000,
        "unit": "lovelace"
      },
      "assets": [
        {
          "policy_id": "65ab82542b0ca20391caaf66a4d4d7897d281f9c136cd3513136945b",
          "asset_name": "string",
          "quantity": 42
        }
      ]
    }
  ],
  "withdrawals": [
    {
      "stake_address": "stake1sjck9mdmfyhzvjhydcjllgj9vjvl522w0573ncustrrr2rg7h9azg4cyqd36yyd48t5ut72hgld0fg2x",
      "amount": {
        "quantity": 42000000,
        "unit": "lovelace"
      },
      "context": "ours"
    }
  ],
  "mint": {
    "tokens": [
      {
        "policy_id": "65ab82542b0ca20391caaf66a4d4d7897d281f9c136cd3513136945b",
        "policy_script": {
          "script_type": "native",
          "script": "string",
          "reference": {
            "id": "1423856bc91c49e928f6f30f4e8d665d53eb4ab6028bd0ac971809d514c92db1",
            "index": 42
          }
        },
        "assets": [
          {
            "asset_name": "string",
            "quantity": 42,
            "fingerprint": "asset1rjklcrnsdzqp65wjgrg55sy9723kw09mlgvlc3"
          }
        ]
      }
    ],
    "wallet_policy_key_hash": "string",
    "wallet_policy_key_index": "1852H"
  },
  "burn": {
    "tokens": [
      {
        "policy_id": "65ab82542b0ca20391caaf66a4d4d7897d281f9c136cd3513136945b",
        "policy_script": {
          "script_type": "native",
          "script": "string",
          "reference": {
            "id": "1423856bc91c49e928f6f30f4e8d665d53eb4ab6028bd0ac971809d514c92db1",
            "index": 42
          }
        },
        "assets": [
          {
            "asset_name": "string",
            "quantity": 42,
            "fingerprint": "asset1rjklcrnsdzqp65wjgrg55sy9723kw09mlgvlc3"
          }
        ]
      }
    ],
    "wallet_policy_key_hash": "string",
    "wallet_policy_key_index": "1852H"
  },
  "certificates": [
    {
      "certificate_type": "join_pool",
      "pool": "pool1wqaz0q0zhtxlgn0ewssevn2mrtm30fgh2g7hr7z9rj5856457mm",
      "reward_account_path": [
        "string"
      ]
    }
  ],
  "metadata": {
    "0": {
      "string": "cardano"
    },
    "1": {
      "int": 14
    },
    "2": {
      "bytes": "2512a00e9653fe49a44a5886202e24d77eeb998f"
    },
    "3": {
      "list": [
        {
          "int": 14
        },
        {
          "int": 42
        },
        {
          "string": "1337"
        }
      ]
    },
    "4": {
      "map": [
        {
          "k": {
            "string": "key"
          },
          "v": {
            "string": "value"
          }
        },
        {
          "k": {
            "int": 14
          },
          "v": {
            "int": 42
          }
        }
      ]
    }
  },
  "deposits_taken": [
    {
      "quantity": 42000000,
      "unit": "lovelace"
    }
  ],
  "deposits_returned": [
    {
      "quantity": 42000000,
      "unit": "lovelace"
    }
  ],
  "script_validity": "valid",
  "validity_interval": {
    "invalid_before": {
      "quantity": 42000,
      "unit": "slot"
    },
    "invalid_hereafter": {
      "quantity": 42000,
      "unit": "slot"
    }
  },
  "witness_count": {
    "verification_key": 42,
    "scripts": [
      {
        "script_type": "native",
        "script": "string",
        "reference": {
          "id": "1423856bc91c49e928f6f30f4e8d665d53eb4ab6028bd0ac971809d514c92db1",
          "index": 42
        }
      }
    ],
    "bootstrap": 42
  }
}

Decode

Path parameters

Body Required

Responses

policy_script object Required

script string(bech32) | object Required

policy_script object Required

script string(bech32) | object Required

metadata object | null

script string(bech32) | object Required