Create
status: stable
Create and send transaction from the wallet.
Body
object
Required
-
The wallet's master passphrase.
Minimum length is
0
, maximum length is255
. -
A list of target outputs with amounts specified.
When creating a new transaction, the wallet software ensures that all user-specified transaction outputs have ada amounts that satisfy the ledger minimum UTxO rule:
If a user-specified transaction output has an ada
amount
that is zero, the wallet software will automatically assign a minimal amount of ada to the output so that it satisfies the ledger minimum UTxO rule.If a user-specified transaction output has an ada
amount
that is non-zero, the wallet software will verify that the specified amount is large enough to satisfy the ledger minimum UTxO rule. If the amount is not large enough, the wallet software will return autxo_too_small
error, together with a revised ada amount that does satisfy the minimum UTxO rule.
At least
0
elements.Hide payments attributes Show payments attributes object
-
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 .
-
Coins, in Lovelace. Only relates to 'Ada'. Refer to
assets
for multi-assets wallets instead.Additional properties are allowed.
-
A flat list of assets (possibly empty).
An asset on the Cardano blockchain. An asset is uniquely identified by its
policy_id
andasset_name
(together, these form the asset id).Two assets with the same
asset_name
andpolicy_id
are interchangeable. Yet, different assets with a samepolicy_id
but differentasset_name
are treated as separate assets, as are two assets with the sameasset_name
but differentpolicy_id
.Hide assets attributes Show assets attributes object
-
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 is56
. -
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
. -
Number of assets for the given
policy_id
andasset_name
.Minimum value is
0
.
-
-
When provided, instruments the server to automatically withdraw rewards from the source wallet when they are deemed sufficient (i.e. they contribute to the balance for at least as much as they cost).
As a consequence, the resulting transaction may or may not have a withdrawal object. Summarizing:
withdrawal field reward balance result null
too small ✓ no withdrawals generated null
big enough ✓ no withdrawals generated "self"
too small ✓ no withdrawals generated "self"
big enough ✓ withdrawal generated Value is
self
. 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
and2^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)
to2^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
orbool
values. When reading metadata from chain, be aware that integers may exceed the javascript numeric range, and may need special "bigint" parsing.-
The TTL (time to live) is the time period in which the transaction will be accepted into node mempools.
After the TTL has lapsed, the transaction is considered expired. At this point, nodes will give up on broadcasting the transaction, and the wallet will release the funds allocated to the transaction so they can be used for other payments.
The TTL should be long enough that the transaction has time to be propagated through the network and confirmed, but short enough so that - in the event of failures - UTxO are returned to the wallet in a timely manner.
The TTL value is given in seconds. It will be converted to a slot number internally.
If the TTL is not provided for a payment, a reasonable default value will be used.
Additional properties are allowed.
-
The wallet's master passphrase.
Minimum length is
0
, maximum length is255
. -
A list of target outputs with amounts specified.
When creating a new transaction, the wallet software ensures that all user-specified transaction outputs have ada amounts that satisfy the ledger minimum UTxO rule:
If a user-specified transaction output has an ada
amount
that is zero, the wallet software will automatically assign a minimal amount of ada to the output so that it satisfies the ledger minimum UTxO rule.If a user-specified transaction output has an ada
amount
that is non-zero, the wallet software will verify that the specified amount is large enough to satisfy the ledger minimum UTxO rule. If the amount is not large enough, the wallet software will return autxo_too_small
error, together with a revised ada amount that does satisfy the minimum UTxO rule.
At least
0
elements.Hide payments attributes Show payments attributes object
-
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 .
-
Coins, in Lovelace. Only relates to 'Ada'. Refer to
assets
for multi-assets wallets instead.Additional properties are allowed.
-
A flat list of assets (possibly empty).
An asset on the Cardano blockchain. An asset is uniquely identified by its
policy_id
andasset_name
(together, these form the asset id).Two assets with the same
asset_name
andpolicy_id
are interchangeable. Yet, different assets with a samepolicy_id
but differentasset_name
are treated as separate assets, as are two assets with the sameasset_name
but differentpolicy_id
.Hide assets attributes Show assets attributes object
-
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 is56
. -
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
. -
Number of assets for the given
policy_id
andasset_name
.Minimum value is
0
.
-
-
When provided, attempts to withdraw rewards from the default stake address corresponding to the given mnemonic.
Should the rewards be null or too small to be worth withdrawing (i.e. the cost of adding them into the transaction is more than their own intrinsic value), the server will reject the request with a
withdrawal_not_beneficial
error.withdrawal field reward balance result any recovery phrase too small x Error 403 withdrawal_not_beneficial
any recovery phrase big enough ✓ withdrawal generated At least
15
but not more than24
elements.
Responses
-
Mempool is Full
-
Unsupported Media Type
-
Not Acceptable
-
Not Found
Hide response attributes Show response attributes object
-
May occur when a given walletId does not match with any known wallets (because it has been deleted, or has never existed).
-
Value is
no_such_wallet
. -
Additional properties are allowed.
-
-
Bad Request
Hide response attributes Show response attributes object
-
Forbidden
One of: Hide attributes Show attributes
-
Occurs when a requested output has a quantity of lovelace that is below the minimum required by the ledger.
-
Value is
utxo_too_small
. -
Additional properties are allowed.
Hide info attributes Show info attributes object
-
Minimum value is
0
. -
Coins, in Lovelace. Only relates to 'Ada'. Refer to
assets
for multi-assets wallets instead.Additional properties are allowed.
-
Coins, in Lovelace. Only relates to 'Ada'. Refer to
assets
for multi-assets wallets instead.Additional properties are allowed.
-
Hide attributes Show attributes
-
Indicates that there's not enough money in the wallet for the operation to succeed.
The 'shortfall' object indicates the additional quantity of each asset that would be needed in order for the operation to succeed.
-
Value is
not_enough_money
. -
Additional properties are allowed.
Hide info attribute Show info attribute object
-
The additional quantity of each asset that would be needed in order for the operation to succeed.
Additional properties are allowed.
Hide shortfall attributes Show shortfall attributes object
-
Coins, in Lovelace. Only relates to 'Ada'. Refer to
assets
for multi-assets wallets instead.Additional properties are allowed.
-
A flat list of assets (possibly empty).
An asset on the Cardano blockchain. An asset is uniquely identified by its
policy_id
andasset_name
(together, these form the asset id).Two assets with the same
asset_name
andpolicy_id
are interchangeable. Yet, different assets with a samepolicy_id
but differentasset_name
are treated as separate assets, as are two assets with the sameasset_name
but differentpolicy_id
.Hide assets attributes Show assets attributes object
-
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 is56
. -
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
. -
Number of assets for the given
policy_id
andasset_name
.Minimum value is
0
.
-
-
-
Hide attributes Show attributes
-
May occur when the given spending passphrase is wrong.
-
Value is
wrong_encryption_passphrase
. -
Additional properties are allowed.
Hide attributes Show attributes
-
Value is
unsupported_era
. -
Additional properties are allowed.
-
-
Accepted
Hide response attributes Show response attributes object
-
A unique identifier for this transaction
Minimum length is
64
, maximum length is64
. -
An amount of Ada spent or received, from the perspective of the wallet.
That is, for outgoing transaction, it represents the amount of Ada consumed as inputs including the amount of Ada spent as fees or deposits.
For incoming transaction, it represents the total amount of Ada received to addresses that belong to the wallet.
Additional properties are allowed.
-
Coins, in Lovelace. Only relates to 'Ada'. Refer to
assets
for multi-assets wallets instead.Additional properties are allowed.
-
Coins, in Lovelace. Only relates to 'Ada'. Refer to
assets
for multi-assets wallets instead.Additional properties are allowed.
-
Coins, in Lovelace. Only relates to 'Ada'. Refer to
assets
for multi-assets wallets instead.Additional properties are allowed.
-
A reference to a particular time slot, and the block height at that point.
Additional properties are allowed.
Hide inserted_at attributes Show inserted_at attributes object
-
The 0-based slot index starting from genesis of the blockchain.
Minimum value is
0
. -
The zero-based slot index within an epoch.
Minimum value is
0
. -
An epoch is a time period which is divided into slots.
Minimum value is
0
. -
Additional properties are allowed.
-
-
A reference to a particular time slot.
Additional properties are allowed.
Hide expires_at attributes Show expires_at attributes object
-
The 0-based slot index starting from genesis of the blockchain.
Minimum value is
0
. -
An epoch is a time period which is divided into slots.
Minimum value is
0
. -
The zero-based slot index within an epoch.
Minimum value is
0
.
-
-
A reference to a particular time slot, and the block height at that point.
Additional properties are allowed.
Hide pending_since attributes Show pending_since attributes object
-
The 0-based slot index starting from genesis of the blockchain.
Minimum value is
0
. -
The zero-based slot index within an epoch.
Minimum value is
0
. -
An epoch is a time period which is divided into slots.
Minimum value is
0
. -
Additional properties are allowed.
-
-
if: status == in_ledger
Current depth of the transaction in the local chainAdditional properties are allowed.
-
Values are
outgoing
orincoming
. -
A list of transaction inputs.
assets
andaddress
are always present foroutgoing
transactions but generally absent forincoming
transactions. This information is present on the Cardano explorer, but is not tracked by the wallet.At least
0
elements.Hide inputs attributes Show inputs attributes object
-
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 .
-
Coins, in Lovelace. Only relates to 'Ada'. Refer to
assets
for multi-assets wallets instead.Additional properties are allowed.
-
A flat list of assets (possibly empty).
An asset on the Cardano blockchain. An asset is uniquely identified by its
policy_id
andasset_name
(together, these form the asset id).Two assets with the same
asset_name
andpolicy_id
are interchangeable. Yet, different assets with a samepolicy_id
but differentasset_name
are treated as separate assets, as are two assets with the sameasset_name
but differentpolicy_id
.Hide assets attributes Show assets attributes object
-
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 is56
. -
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
. -
Number of assets for the given
policy_id
andasset_name
.Minimum value is
0
.
-
-
A unique identifier for this transaction
Minimum length is
64
, maximum length is64
. -
Minimum value is
0
.
-
-
A list of target outputs with amounts specified.
When creating a new transaction, the wallet software ensures that all user-specified transaction outputs have ada amounts that satisfy the ledger minimum UTxO rule:
If a user-specified transaction output has an ada
amount
that is zero, the wallet software will automatically assign a minimal amount of ada to the output so that it satisfies the ledger minimum UTxO rule.If a user-specified transaction output has an ada
amount
that is non-zero, the wallet software will verify that the specified amount is large enough to satisfy the ledger minimum UTxO rule. If the amount is not large enough, the wallet software will return autxo_too_small
error, together with a revised ada amount that does satisfy the minimum UTxO rule.
At least
0
elements.Hide outputs attributes Show outputs attributes object
-
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 .
-
Coins, in Lovelace. Only relates to 'Ada'. Refer to
assets
for multi-assets wallets instead.Additional properties are allowed.
-
A flat list of assets (possibly empty).
An asset on the Cardano blockchain. An asset is uniquely identified by its
policy_id
andasset_name
(together, these form the asset id).Two assets with the same
asset_name
andpolicy_id
are interchangeable. Yet, different assets with a samepolicy_id
but differentasset_name
are treated as separate assets, as are two assets with the sameasset_name
but differentpolicy_id
.Hide assets attributes Show assets attributes object
-
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 is56
. -
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
. -
Number of assets for the given
policy_id
andasset_name
.Minimum value is
0
.
-
-
A list of transaction inputs used for collateral.
At least
0
elements.Hide collateral attributes Show collateral attributes object
-
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 .
-
Coins, in Lovelace. Only relates to 'Ada'. Refer to
assets
for multi-assets wallets instead.Additional properties are allowed.
-
A unique identifier for this transaction
Minimum length is
64
, maximum length is64
. -
Minimum value is
0
.
-
-
A list of collateral return outputs with amounts specified.
At least
0
but not more than1
element.Hide collateral_outputs attributes Show collateral_outputs attributes object
-
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 .
-
Coins, in Lovelace. Only relates to 'Ada'. Refer to
assets
for multi-assets wallets instead.Additional properties are allowed.
-
A flat list of assets (possibly empty).
An asset on the Cardano blockchain. An asset is uniquely identified by its
policy_id
andasset_name
(together, these form the asset id).Two assets with the same
asset_name
andpolicy_id
are interchangeable. Yet, different assets with a samepolicy_id
but differentasset_name
are treated as separate assets, as are two assets with the sameasset_name
but differentpolicy_id
.Hide assets attributes Show assets attributes object
-
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 is56
. -
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
. -
Number of assets for the given
policy_id
andasset_name
.Minimum value is
0
.
-
-
-
A list of withdrawals from stake addresses.
At least
0
elements.Hide withdrawals attributes Show withdrawals attributes object
-
Coins, in Lovelace. Only relates to 'Ada'. Refer to
assets
for multi-assets wallets instead.Additional properties are allowed.
-
Current transaction status.
*-----------* ---> | PENDING |----------------* *-----------* | | | V V *-----------* *-----------* | |----------> EXPIRED | | | (ttl) *-----------* | SUBMITTED | | <----------------* | | | *-----------* (rollback) | | (in ledger) *-----------* | | | *---------------> IN_LEDGER | | | *-----------*
Values are
pending
,submitted
,in_ledger
, orexpired
. 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
and2^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)
to2^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
orbool
values. When reading metadata from chain, be aware that integers may exceed the javascript numeric range, and may need special "bigint" parsing.-
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
orinvalid
. -
Any certificate that could occur in an arbitrary transaction: might be related to delegation, pool activities, genesis or MIR.
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: A delegation certificate belonging to wallet
Only for 'join_pool' the 'pool' property is required.
A delegation certificate not belonging to wallet
Only for 'join_pool' the 'pool' property is required.
Hide attributes Show attributes
-
Value is
register_pool
. -
A unique identifier for the pool.
-
At least
0
elements. Format of each should match the following pattern:^(ed25519_pk)1[0-9a-z]*$
. -
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.
Additional properties are allowed.
-
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.
Additional properties are allowed.
-
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.
Additional properties are allowed.
-
Additional properties are allowed.
-
-
Additional properties are allowed.
Hide mint attributes Show mint attributes object
-
At least
0
elements.Hide tokens attributes Show tokens attributes object
-
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 is56
. policy_script
object Required One of: Hide attributes Show attributes
-
Value is
native
. script
string(bech32) | object Required One of: 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
-
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: 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
-
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.
Additional properties are allowed.
-
Hide attribute Show attribute
-
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: 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
-
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.
Additional properties are allowed.
-
Hide attribute Show attribute
-
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.
Additional properties are allowed.
Hide some attributes Show some attributes object
-
Minimum value is
1
, maximum value is255
. -
At least
1
element.One of: 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
-
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.
Additional properties are allowed.
-
-
-
-
A reference input.
Additional properties are allowed.
Hide attributes Show attributes
-
Value is
plutus
. -
Additional properties are allowed.
-
A reference input.
Additional properties are allowed.
Hide attributes Show attributes
-
Value is
reference script
. -
Minimum length is
56
, maximum length is56
. -
A reference input.
At least
1
element.
-
-
At least
1
element.Hide assets attributes Show assets attributes object
-
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
. -
Number of assets for the given
policy_id
andasset_name
.Minimum value is
0
. -
A user-facing short fingerprint which combines the
policy_id
andasset_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 is44
. Format should match the following pattern:^(asset)1[0-9a-z]*$
.
-
-
-
Format should match the following pattern:
^((policy_vk)|(policy_vkh))1[0-9a-z]*$
. -
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 aH
suffix are called Soft.
-
-
Additional properties are allowed.
Hide burn attributes Show burn attributes object
-
At least
0
elements.Hide tokens attributes Show tokens attributes object
-
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 is56
. policy_script
object Required One of: Hide attributes Show attributes
-
Value is
native
. script
string(bech32) | object Required One of: 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
-
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: 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
-
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.
Additional properties are allowed.
-
Hide attribute Show attribute
-
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: 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
-
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.
Additional properties are allowed.
-
Hide attribute Show attribute
-
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.
Additional properties are allowed.
Hide some attributes Show some attributes object
-
Minimum value is
1
, maximum value is255
. -
At least
1
element.One of: 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
-
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.
Additional properties are allowed.
-
-
-
-
A reference input.
Additional properties are allowed.
Hide attributes Show attributes
-
Value is
plutus
. -
Additional properties are allowed.
-
A reference input.
Additional properties are allowed.
Hide attributes Show attributes
-
Value is
reference script
. -
Minimum length is
56
, maximum length is56
. -
A reference input.
At least
1
element.
-
-
At least
1
element.Hide assets attributes Show assets attributes object
-
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
. -
Number of assets for the given
policy_id
andasset_name
.Minimum value is
0
. -
A user-facing short fingerprint which combines the
policy_id
andasset_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 is44
. Format should match the following pattern:^(asset)1[0-9a-z]*$
.
-
-
-
Format should match the following pattern:
^((policy_vk)|(policy_vkh))1[0-9a-z]*$
. -
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 aH
suffix are called Soft.
-
-
Additional properties are allowed.
Hide validity_interval attributes Show validity_interval attributes object
-
Additional properties are allowed.
-
Additional properties are allowed.
-
-
A script data integrity hash - 32 bytes
Format should match the following pattern:
^(script_data)1[0-9a-z]*$
. -
An extra signature hash - 28 bytes
At least
0
elements. Format of each should match the following pattern:^(req_signer_vkh)1[0-9a-z]*$
.
-
curl \
--request POST 'https://localhost:8090/v2/wallets/{walletId}/transactions' \
--header "Content-Type: application/json" \
--data '{"passphrase":"Secure Passphrase","payments":[{"address":"addr1sjck9mdmfyhzvjhydcjllgj9vjvl522w0573ncustrrr2rg7h9azg4cyqd36yyd48t5ut72hgld0fg2xfvz82xgwh7wal6g2xt8n996s3xvu5g","amount":{"quantity":42000000,"unit":"lovelace"},"assets":[{"policy_id":"65ab82542b0ca20391caaf66a4d4d7897d281f9c136cd3513136945b","asset_name":"string","quantity":42}]}],"withdrawal":"self","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}}]}},"time_to_live":{"quantity":10.0,"unit":"second"}}'
{
"passphrase": "Secure Passphrase",
"payments": [
{
"address": "addr1sjck9mdmfyhzvjhydcjllgj9vjvl522w0573ncustrrr2rg7h9azg4cyqd36yyd48t5ut72hgld0fg2xfvz82xgwh7wal6g2xt8n996s3xvu5g",
"amount": {
"quantity": 42000000,
"unit": "lovelace"
},
"assets": [
{
"policy_id": "65ab82542b0ca20391caaf66a4d4d7897d281f9c136cd3513136945b",
"asset_name": "string",
"quantity": 42
}
]
}
],
"withdrawal": "self",
"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
}
}
]
}
},
"time_to_live": {
"quantity": 10.0,
"unit": "second"
}
}
{
"passphrase": "Secure Passphrase",
"payments": [
{
"address": "addr1sjck9mdmfyhzvjhydcjllgj9vjvl522w0573ncustrrr2rg7h9azg4cyqd36yyd48t5ut72hgld0fg2xfvz82xgwh7wal6g2xt8n996s3xvu5g",
"amount": {
"quantity": 42000000,
"unit": "lovelace"
},
"assets": [
{
"policy_id": "65ab82542b0ca20391caaf66a4d4d7897d281f9c136cd3513136945b",
"asset_name": "string",
"quantity": 42
}
]
}
],
"withdrawal": [
"squirrel",
"material",
"silly",
"twice",
"direct",
"slush",
"pistol",
"razor",
"become",
"junk",
"kingdom",
"flee",
"squirrel",
"silly",
"twice"
]
}
{
"message": "string",
"code": "mempool_is_full"
}
{
"message": "string",
"code": "unsupported_media_type"
}
{
"message": "string",
"code": "not_acceptable"
}
{
"message": "string",
"code": "no_such_wallet",
"info": {
"wallet_id": "2512a00e9653fe49a44a5886202e24d77eeb998f"
}
}
{
"message": "string",
"code": "bad_request"
}
{
"message": "string",
"code": "invalid_wallet_type"
}
{
"message": "string",
"code": "already_withdrawing"
}
{
"message": "string",
"code": "utxo_too_small",
"info": {
"tx_output_index": 42,
"tx_output_lovelace_specified": {
"quantity": 42000000,
"unit": "lovelace"
},
"tx_output_lovelace_required_minimum": {
"quantity": 42000000,
"unit": "lovelace"
}
}
}
{
"message": "string",
"code": "cannot_cover_fee"
}
{
"message": "string",
"code": "no_utxos_available"
}
{
"message": "string",
"code": "not_enough_money",
"info": {
"shortfall": {
"ada": {
"quantity": 42000000,
"unit": "lovelace"
},
"assets": [
{
"policy_id": "65ab82542b0ca20391caaf66a4d4d7897d281f9c136cd3513136945b",
"asset_name": "string",
"quantity": 42
}
]
}
}
}
{
"message": "string",
"code": "insufficient_collateral"
}
{
"message": "string",
"code": "transaction_is_too_big"
}
{
"message": "string",
"code": "no_root_key"
}
{
"message": "string",
"code": "wrong_encryption_passphrase",
"info": {
"wallet_id": "2512a00e9653fe49a44a5886202e24d77eeb998f"
}
}
{
"message": "string",
"code": "unsupported_era",
"info": {
"unsupported_era": "byron",
"supported_eras": [
"byron"
]
}
}
{
"id": "1423856bc91c49e928f6f30f4e8d665d53eb4ab6028bd0ac971809d514c92db1",
"amount": {
"quantity": 42000000,
"unit": "lovelace"
},
"fee": {
"quantity": 42000000,
"unit": "lovelace"
},
"deposit_taken": {
"quantity": 42000000,
"unit": "lovelace"
},
"deposit_returned": {
"quantity": 42000000,
"unit": "lovelace"
},
"inserted_at": {
"absolute_slot_number": 8086,
"slot_number": 1337,
"epoch_number": 14,
"time": "2019-02-27T14:46:45Z",
"height": {
"quantity": 1337,
"unit": "block"
}
},
"expires_at": {
"absolute_slot_number": 8086,
"epoch_number": 14,
"slot_number": 1337,
"time": "2019-02-27T14:46:45Z"
},
"pending_since": {
"absolute_slot_number": 8086,
"slot_number": 1337,
"epoch_number": 14,
"time": "2019-02-27T14:46:45Z",
"height": {
"quantity": 1337,
"unit": "block"
}
},
"depth": {
"quantity": 1337,
"unit": "block"
},
"direction": "outgoing",
"inputs": [
{
"address": "addr1sjck9mdmfyhzvjhydcjllgj9vjvl522w0573ncustrrr2rg7h9azg4cyqd36yyd48t5ut72hgld0fg2xfvz82xgwh7wal6g2xt8n996s3xvu5g",
"amount": {
"quantity": 42000000,
"unit": "lovelace"
},
"assets": [
{
"policy_id": "65ab82542b0ca20391caaf66a4d4d7897d281f9c136cd3513136945b",
"asset_name": "string",
"quantity": 42
}
],
"id": "1423856bc91c49e928f6f30f4e8d665d53eb4ab6028bd0ac971809d514c92db1",
"index": 42
}
],
"outputs": [
{
"address": "addr1sjck9mdmfyhzvjhydcjllgj9vjvl522w0573ncustrrr2rg7h9azg4cyqd36yyd48t5ut72hgld0fg2xfvz82xgwh7wal6g2xt8n996s3xvu5g",
"amount": {
"quantity": 42000000,
"unit": "lovelace"
},
"assets": [
{
"policy_id": "65ab82542b0ca20391caaf66a4d4d7897d281f9c136cd3513136945b",
"asset_name": "string",
"quantity": 42
}
]
}
],
"collateral": [
{
"address": "addr1sjck9mdmfyhzvjhydcjllgj9vjvl522w0573ncustrrr2rg7h9azg4cyqd36yyd48t5ut72hgld0fg2xfvz82xgwh7wal6g2xt8n996s3xvu5g",
"amount": {
"quantity": 42000000,
"unit": "lovelace"
},
"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"
}
}
],
"status": "pending",
"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
}
}
]
}
},
"script_validity": "valid",
"certificates": [
{
"certificate_type": "join_pool",
"pool": "pool1wqaz0q0zhtxlgn0ewssevn2mrtm30fgh2g7hr7z9rj5856457mm",
"reward_account_path": [
"string"
]
}
],
"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"
},
"validity_interval": {
"invalid_before": {
"quantity": 42000,
"unit": "slot"
},
"invalid_hereafter": {
"quantity": 42000,
"unit": "slot"
}
},
"script_integrity": [
"script_data16apaenn9ut6s40lcw3l8v68xawlrlq20z2966uzcx8jmv2q9uy7qau558d"
],
"extra_signatures": [
"addr_keyhash1gr69m385thgvkrtspk73zmkwk537wxyxuevs2u9cukglvtlkz4k"
]
}