Jump to
Ctrl
+
/

Create Coins Transaction Request from Wallet

POST
/wallet-as-a-service/wallets/{walletId}/{blockchain}/{network}/transaction-requests

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.

This is available only for UTXO-based protocols such as Bitcoin, Bitcoin Cash, Litecoin, etc. It is not available for Account-based protocols like Ethereum.

Path Parameters

blockchain string Required

Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.

network string Required

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 network like "testnet" is a test network.

walletId string Required

Represents the sender's specific and unique Wallet ID of the sender.

Query Parameters

context string Optional

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

context string Optional

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.

data object Required
item object Required
callbackSecretKey string Optional

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.

callbackUrl string Optional

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.

feePriority string Required

Represents the fee priority of the automation, whether it is "slow", "standard" or "fast".

note string Optional

Represents an optional note to add a free text in, explaining or providing additional detail on the transaction request.

prepareStrategy string Optional

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).

recipients array Items (object) Required

Defines the destination of the transaction, whether it is incoming or outgoing.

address string Required

Defines the specific recipient/destination address.

amount string Required

Represents the specific amount of the transaction's destination.

Response Schema

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2021-03-20
requestId string Required

Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.

601c1710034ed6d407996b30
context string Optional

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.

yourExampleString
data object Required
item object Required
callbackSecretKey string Optional

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.

yourSecretKey
callbackUrl string Optional

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.

https://example.com
feePriority string Required

Represents the fee priority of the automation, whether it is "slow", "standard" or "fast".

standard
note string Optional

Represents an optional note to add a free text in, explaining or providing additional detail on the transaction request.

yourAdditionalInformationhere
recipients array Items (object) Required

Defines the destination of the transaction, whether it is incoming or outgoing.

address string Required

Defines the specific destination address.

mmd963W1fECjLyaDCHcioSCZYHkRwjkhtr
amount string Required

Represents the specific amount of the transaction's destination.

0.00123
totalTransactionAmount string Required

Represents the specific amount of the transaction.

0.001
transactionRequestId string Required

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.

6017dd02a309213863be9e55
transactionRequestStatus string Required

Defines the status of the transaction, e.g. "created, "await_approval", "pending", "prepared", "signed", "broadcasted", "success", "failed", "rejected", mined".

created

Callback parameters

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2021-03-20
referenceId string Required

Represents a unique identifier that serves as reference to the specific request which prompts a callback, e.g. Blockchain Events Subscription, Blockchain Automation, etc.

6038d09050653d1f0e40584c
idempotencyKey string Required

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.

e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c
data object Required

Specifies all data, as attributes, included into the callback notification, which depends on the event.

product string Required

Represents the Crypto APIs 2.0 product which sends the callback.

WALLET_AS_A_SERVICE
event string Required

Defines the specific event, for which a callback subscription is set.

TRANSACTION_REQUEST_APPROVAL
item object Required

Defines an item as one result.

blockchain string Required

Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.

Bitcoin/Ethereum (whichever applicable)
network string Required

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", "sepolia", "mordor" are test networks.

Testnet/Mainnet (whichever applicable)
requiredApprovals integer Required

The required number of approvals needed to approve the transaction.

2
requiredRejections integer Required

The required number of rejections needed to reject the transaction.

2
currentApprovals integer Required

The current number of approvals given for the transaction.

1
currentRejections integer Required

The current number of rejections given for the transaction.

0

Credits Cost : 500 Credits for 1 Results

Was this page helpful?
Yes
No
Language
URL

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "item": {
            "callbackSecretKey": "yourSecretKey",
            "callbackUrl": "https://example.com",
            "feePriority": "standard",
            "note": "yourAdditionalInformationhere",
            "recipients": [
                {
                    "address": "mmd963W1fECjLyaDCHcioSCZYHkRwjkhtr",
                    "amount": "0.00123"
                }
            ],
            "totalTransactionAmount": "0.001",
            "transactionRequestId": "6017dd02a309213863be9e55",
            "transactionRequestStatus": "created"
        }
    }
}
{
    "apiVersion": "2021-03-20",
    "referenceId": "6038d09050653d1f0e40584c",
    "idempotencyKey": "e55bf7a4a7188855f1c27541a6c387d04cc3b22ee34d1304b0e6ecad61c9906c",
    "data": {
        "product": "WALLET_AS_A_SERVICE",
        "event": "TRANSACTION_REQUEST_APPROVAL",
        "item": {
            "blockchain": "Bitcoin/Ethereum (whichever applicable)",
            "network": "Testnet/Mainnet (whichever applicable)",
            "requiredApprovals": 2,
            "requiredRejections": 2,
            "currentApprovals": 1,
            "currentRejections": 0
        }
    }
}