Prepare A UTXO-Based Transaction From HD Wallet (xPub, yPub, zPub)
Through the “Prepare a UTXO-based transaction from xPub” endpoint users can prepare a transaction for signing from all synced with Crypto APIs addresses for the specific xPub. This is based on the selectionStrategy
and the addresses’ balances. In the case a user has an address not synced with Crypto APIs, it will not be included. This endpoint applies to all supported UTXO-based blockchain protocols, e.g. Bitcoin, Litecoin, etc.
Path Parameters
-
Requiredblockchain string
Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
-
Requirednetwork string
Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - "mainnet" is the live network with actual data while networks like "testnet", "ropsten" are test networks.
Query parameters
-
Optionalcontext string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error.
context
is specified by the user.
Request body schema application/json
-
Optionalcontext string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error.
context
is specified by the user. -
Requireddata object
-
Requireditem object
-
OptionaladditionalData string
Representation of the additional data.
-
Optionallocktime integer
Represents the time at which a particular transaction can be added to the blockchain.
-
Requiredxpub string
Defines the account extended publicly known key which is used to derive all child public keys.
-
Requiredfee object
When isConfirmed is True - Defines the amount of the transaction fee When isConfirmed is False - For ETH-based blockchains this attribute represents the max fee value.
-
Optionaladdress string
Representation of the address
-
OptionalexactAmount string
Representation of the exact amount
-
Optionalpriority string
Representation of the fee priority
-
-
OptionalprepareStrategy string
Representation of the transaction's strategy type
-
Requiredrecipients array
Items (object)Object Array representation of transaction receivers
-
Requiredaddress string
Representation of the receiver address
-
Requiredamount string
Representation of the amount
-
-
Optionalreplaceable boolean
Representation of whether the transaction is replaceable. This is an Optional attribute that is not supported for Dogecoin, Dash and Bitcoin-Cash.
-
-
Response schema
Content-Type: application/json
The resource has been successfully submitted.
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2021-03-20 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error.
context
is specified by the user.Example : yourExampleString -
Requireddata object
-
Requireditem object
-
OptionaladditionalData string
Representation of the additional data
Example : yourAdditionalDataHere -
Requiredfee string
When isConfirmed is True - Defines the amount of the transaction fee When isConfirmed is False - For ETH-based blockchains this attribute represents the max fee value.
Example : 0.0000279 -
OptionalfeePerByte string
Defines the fee per byte value
Example : 0.00000014 -
Requiredlocktime integer
Represents the time at which a particular transaction can be added to the blockchain.
Example : 1781965 -
Requiredsize integer
Represents the total size of this transaction.
Example : 243 -
Optionalversion integer
Representation of the transaction's version
Example : 2 -
RequiredblockchainSpecific object One Ofobject
-
Optionalreplaceable boolean
Representation of whether the transaction is replaceable
Example : False -
Requiredvin array
Represents the transaction inputs.
-
Requiredaddress string
Representation of the address
Example : tb1q8wus03xdv3t6aknmsnpd0jmeu7dgh93j34pj5a -
Requiredchange integer
Representation of the change value
Example : 0 -
RequiredderivationIndex integer
Representation of the derivation index of the xpub
Example : 1 -
RequiredoutputIndex integer
Representation of the output index
Example : 1 -
Requiredsatoshis integer
Representation of the satoshis value
Example : 10000 -
Requiredscript string
Representation of the script string
Example : 00143bb907c4cd6457aeda7b84c2d7cb79e79a8b9632 -
Requiredsighash string
Representation of the hash that should be signed.
Example : 90cfeef03b2755586b8e81668d8009b16b34d48abf2968729892279222e8d893 -
RequiredtransactionId string
Represents the reference transaction identifier.
Example : ff59ac56616ece7498e62c7f9f957cfdd50f6f2a74402058154e3022e7617bf2
-
-
Requiredvout array
Represents the transaction outputs.
-
Requiredaddress string
Representation of the address
Example : tb1qvx3fynjuctk475vgecetfck005fxh699mflshv -
Requiredsatoshis integer
Representation of the satoshis value
Example : 3094 -
Requiredscript string
Representation of the script
Example : 0014a3f1019940ce572681c43fd836db97036a85bc8f
-
-
-
-