Create Coins Transaction Request from Wallet
Through this endpoint users can create a new transaction request from the entire Wallet instead from just a specific address. This endpoint can generate transactions from multiple to multiple addresses.
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.
-
RequiredwalletId string
Represents the sender's specific and unique Wallet ID of the sender.
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
-
OptionalcallbackSecretKey string
Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. For more information please see our Documentation.
-
OptionalcallbackUrl string
Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs.
We support ONLY httpS type of protocol
. -
RequiredfeePriority string
Represents the fee priority of the automation, whether it is "slow", "standard" or "fast".
-
Optionalnote string
Represents an optional note to add a free text in, explaining or providing additional detail on the transaction request.
-
OptionalprepareStrategy string
Refers to a model of a UTXO spending strategy, where customers can choose how to spend their transaction outputs from multiple Bitcoin addresses. Two options available - "minimize-dust" (select lower amounts from multiple addresses) or "optimize-size" (select higher amounts from less addresses).
-
Requiredrecipients array
Items (object)Defines the destination of the transaction, whether it is incoming or outgoing.
-
Requiredaddress string
Defines the specific recipient/destination address.
-
Requiredamount string
Represents the specific amount of the transaction's destination.
-
-
-
Response schema
Content-Type: application/json
The resource has been successfully created.
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
-
OptionalcallbackSecretKey string
Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. For more information please see our Documentation.
Example : yourSecretKey -
OptionalcallbackUrl string
Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs.
We support ONLY httpS type of protocol
.Example : https://example.com -
RequiredfeePriority string
Represents the fee priority of the automation, whether it is "slow", "standard" or "fast".
Example : standard -
Optionalnote string
Represents an optional note to add a free text in, explaining or providing additional detail on the transaction request.
Example : yourAdditionalInformationhere -
Requiredrecipients array
Defines the destination of the transaction, whether it is incoming or outgoing.
-
Requiredaddress string
Defines the specific destination address.
Example : mmd963W1fECjLyaDCHcioSCZYHkRwjkhtr -
Requiredamount string
Represents the specific amount of the transaction's destination.
Example : 0.00123
-
-
RequiredtotalTransactionAmount string
Represents the specific amount of the transaction.
Example : 0.001 -
RequiredtransactionRequestId string
Represents a unique identifier of the transaction request (the request sent to make a transaction), which helps in identifying which callback and which
referenceId
concern that specific transaction request.Example : 6017dd02a309213863be9e55 -
RequiredtransactionRequestStatus string
Defines the status of the transaction, e.g. "created, "await_approval", "pending", "prepared", "signed", "broadcasted", "success", "failed", "rejected", mined".
Example : created
-
-
Callback parameters Method : POST
Content-Type : application/json
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2021-03-20 -
RequiredreferenceId string
Represents a unique identifier that serves as reference to the specific request which prompts a callback, e.g. Blockchain Events Subscription, Blockchain Automation, etc.
Example : 6038d09050653d1f0e40584c -
RequiredidempotencyKey string
Specifies a unique ID generated by the system and attached to each callback. It is used by the server to recognize consecutive requests with the same data with the purpose not to perform the same operation twice.
Example : e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c -
Requireddata object
Specifies all data, as attributes, included into the callback notification, which depends on the
event
.-
Requiredproduct string
Represents the Crypto APIs 2.0 product which sends the callback.
Example : WALLET_AS_A_SERVICE -
Requiredevent string
Defines the specific event, for which a callback subscription is set.
Example : TRANSACTION_REQUEST_APPROVAL -
Requireditem object
Defines an
item
as one result.-
Requiredblockchain string
Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
Example : ethereum -
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", "rinkeby" are test networks.
Example : ropsten -
RequiredrequiredApprovals integer
The required number of approvals needed to approve the transaction.
Example : 2 -
RequiredrequiredRejections integer
The required number of rejections needed to reject the transaction.
Example : 2 -
RequiredcurrentApprovals integer
The current number of approvals given for the transaction.
Example : 1 -
RequiredcurrentRejections integer
The current number of rejections given for the transaction.
Example : 0
-
-