Jump to
Ctrl
+
/

Get Transaction Request Details

GET
/wallet-as-a-service/transactionRequests/{transactionRequestId}

Through this endpoint customers can obtain details on transaction request.

This regards transaction requests, which is not to be confused with transactions. Transaction requests may not be approved due to any reason, hence a transaction may not occur.

Path Parameters

transactionRequestId string Required

Represents the unique ID of the transaction request.

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.

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
additionalDetails string Required

Defines an optional note for additional details.

yourExampleStringHere
blockchain string Required

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

bitcoin
feePriority string Required

Defines the priority for the fee, if it is "slow", "standard" or "fast".

standard
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" are test networks.

testnet
recipients array Items (object) Required

Represents a list of recipient addresses with the respective amounts. In account-based protocols like Ethereum there is only one address in this list.

address string Required

The address which receives this transaction. In UTXO-based protocols like Bitcoin there could be several senders while in account-based protocols like Ethereum there is always only one recipient.

mr3zKBc7skyDHcVHWww4JzzziPnrdYTscR
addressTag integer Optional

Defines a specific Tag that is an additional XRP address feature. It helps identify a transaction recipient beyond a wallet address. The tag that was encoded into the x-Address along with the Classic Address.

3999472835
amount string Required

Represents the amount received to this address.

0.001
classicAddress string Optional

Represents the public address, which is a compressed and shortened form of a public key. A classic address is shown when the destination address is an x-Address.

rA9bXGJcXvZKaWofrRphdJsBWzhyCfH3z
unit string Required

Defines the unit of the amount.

BTC
totalTransactionAmount string Required

Defines the total transaction amount.

0.001
transactionId string Optional

Represents the unique identifier of a transaction, i.e. it could be transactionId in UTXO-based protocols like Bitcoin, and transaction hash in Ethereum blockchain.

61922aa68f192800067a8404
transactionRequestStatus string Required

Defines the status of the transaction request, e.g. pending.

created
transactionType string Required

Defines the transaction type, if it is for coins or tokens.

coin
unit string Required

Defines the unit of the amount.

BTC
walletId string Required

Defines the unique ID of the Wallet.

60c9d9921c38030006675ff6

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": {
            "additionalDetails": "yourExampleStringHere",
            "blockchain": "bitcoin",
            "feePriority": "standard",
            "network": "testnet",
            "recipients": [
                {
                    "address": "mr3zKBc7skyDHcVHWww4JzzziPnrdYTscR",
                    "addressTag": 3999472835,
                    "amount": "0.001",
                    "classicAddress": "rA9bXGJcXvZKaWofrRphdJsBWzhyCfH3z",
                    "unit": "BTC"
                }
            ],
            "totalTransactionAmount": "0.001",
            "transactionId": "61922aa68f192800067a8404",
            "transactionRequestStatus": "created",
            "transactionType": "coin",
            "unit": "BTC",
            "walletId": "60c9d9921c38030006675ff6"
        }
    }
}