Jump to

• Request
• Response
• Examples

Get Transaction Information

get

/restproxy/api/v2/channels/{channelName}/transactions/{transactionId}

Get the information for a transaction stating whether it's submitted or not.

Request

Supported Media Types

• application/json

Path Parameters

• channelName: string
  ID of the channel
• transactionId: string
  ID of the transaction

Query Parameters

• role: string
  The name of the Hyperledger Fabric enrollment to be used

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: object

Show Source

• error(optional): string
• result(optional): object result
• returnCode: string
  Allowed Values: [ "Success", "Failure" ]

{
    "type":"object",
    "required":[
        "returnCode"
    ],
    "properties":{
        "returnCode":{
            "$ref":"#/definitions/returnCode"
        },
        "error":{
            "type":"string"
        },
        "result":{
            "type":"object",
            "required":[
                "txid",
                "status"
            ],
            "properties":{
                "txid":{
                    "description":"Transaction ID",
                    "type":"string"
                },
                "status":{
                    "description":"Transaction status",
                    "type":"string",
                    "enum":[
                        "valid",
                        "invalid",
                        "not found"
                    ]
                },
                "message":{
                    "type":"string"
                },
                "payload":{
                    "$ref":"#/definitions/AnyValue"
                },
                "encode":{
                    "$ref":"#/definitions/encode"
                }
            }
        }
    }
}

Nested Schema : result

Type: object

Show Source

• encode(optional): string
  Allowed Values: [ "UTF-8", "JSON", "base64" ]
• message(optional): string
• payload(optional):
• status: string
  Allowed Values: [ "valid", "invalid", "not found" ]

  Transaction status
• txid: string
  Transaction ID

{
    "type":"object",
    "required":[
        "txid",
        "status"
    ],
    "properties":{
        "txid":{
            "description":"Transaction ID",
            "type":"string"
        },
        "status":{
            "description":"Transaction status",
            "type":"string",
            "enum":[
                "valid",
                "invalid",
                "not found"
            ]
        },
        "message":{
            "type":"string"
        },
        "payload":{
            "$ref":"#/definitions/AnyValue"
        },
        "encode":{
            "$ref":"#/definitions/encode"
        }
    }
}

400 Response

Bad Request

401 Response

Not authorized

403 Response

Forbidden

404 Response

Invalid parameters

500 Response

Service unavailable

Back to Top

Examples

This endpoint is used to get the status and other details of a transaction based on it's transaction ID.

The following example shows how to get the transaction details of your Blockchain transaction by submitting a GET request on the REST resource using cURL.

curl -v -u <username>:<password> -X GET \
  "https://<restproxy of your Blockchain instance>/api/v2/channels/<channel_name>/transactions/{transactionId}" \
  -H "accept: application/json"

For example,

curl -v -k -u obpuser:<password> -X GET \
  "https://myvm.oracle.com:10001/restproxy/api/v2/channels/default/transactions/bc5221c648533646877505288fc50b6c6100394213694bf111f7a3183074a329" \
  -H "accept: application/json"

Note:

You can find the restproxy value of your Blockchain instance from the Nodes tab of your instance console.

Example of the Response Body

The following example shows the contents of the response body in JSON format:

{
    "returnCode": "Success",
    "error": "",
    "result": {
        "txid": "bc5221c648533646877505288fc50b6c6100394213694bf111f7a3183074a329",
        "status": "valid",
        "payload": 800,
        "encode": "JSON"
    }
}

As this transaction was invoked to query the balance of a, the value returned for payload can be interpreted as a's balance amount.

Back to Top