Get Transaction Request Details

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.

Single Result - This endpoint returns only one single result. GET /wallet-as-a-service/transactionRequests/{transactionRequestId}

Path Parameters

  • Required
    transactionRequestId string

    Represents the unique ID of the transaction request.

    Example : 6115126693397c0006f78eb4

Query parameters

  • Optional
    context 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.

Response schema

200 400 401 402 403 409 415 422 429 500
HTTP Status Code: 200
Content-Type: application/json

The request has been successful.

  • Object :

  • Required
    apiVersion string

    Specifies the version of the API that incorporates this endpoint.

    Example : 2.0
  • Required
    requestId string

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

    Example : 601c1710034ed6d407996b30
  • Optional
    context 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 : You can add any text here
  • Required
    data object
    • Required
      item object
      • Required
        additionalDetails string

        Defines an optional note for additional details.

        Example : yourExampleStringHere
      • Required
        blockchain string

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

        Example : bitcoin
        Possible Values : bitcoin bitcoin-cash litecoin dogecoin dash ethereum ethereum-classic zcash
      • Required
        feePriority string

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

        Example : standard
        Possible Values : slow standard fast
      • Required
        network 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.

        Example : testnet
        Possible Values : mainnet testnet ropsten mordor
      • Required
        recipients array

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

        • Required
          address string

          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.

          Example : mr3zKBc7skyDHcVHWww4JzzziPnrdYTscR
        • Required
          amount string

          Represents the amount received to this address.

          Example : 0.001
        • Required
          unit string

          Defines the unit of the amount.

          Example : BTC
      • Required
        totalTransactionAmount string

        Defines the total transaction amount.

        Example : 0.001
      • Required
        transactionRequestStatus string

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

        Example : created
        Possible Values : created await-approval pending prepared signed broadcasted success failed rejected mined
      • Required
        transactionType string

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

        Example : coin
        Possible Values : coin token
      • Required
        unit string

        Defines the unit of the amount.

        Example : BTC
      • Required
        walletId string

        Defines the unique ID of the Wallet.

        Example : 60c9d9921c38030006675ff6

Credits Cost : 5 Credits For 1 Result(s)

Try it out

Request Example

GET
https://rest.cryptoapis.io/v2/wallet-as-a-service/transactionRequests/6115126693397c0006f78eb4
Headers
Host: https://rest.cryptoapis.io/v2
Content-Type: application/json
X-API-Key: my-api-key

Response Example

{
    "apiVersion": "2.0",
    "requestId": "601c1710034ed6d407996b30",
    "context": "You can add any text here",
    "data": {
        "item": {
            "additionalDetails": "yourExampleStringHere",
            "blockchain": "bitcoin",
            "feePriority": "standard",
            "network": "testnet",
            "recipients": [
                {
                    "address": "mr3zKBc7skyDHcVHWww4JzzziPnrdYTscR",
                    "amount": "0.001",
                    "unit": "BTC"
                }
            ],
            "totalTransactionAmount": "0.001",
            "transactionRequestStatus": "created",
            "transactionType": "coin",
            "unit": "BTC",
            "walletId": "60c9d9921c38030006675ff6"
        }
    }
}