REST API for Oracle Blockchain Platform Enterprise Edition

Get Transaction Information

get

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

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

Request

Supported Media Types

application/json

Path Parameters

channelName(required): string

ID of the channel
transactionId(required): string

ID of the transaction

Query Parameters

role: string

Name of the Hyperledger Fabric enrollment to be used

Response

Supported Media Types

application/json

200 Response

Operation successful

Root Schema : schema

Type: object

Show Source

error: string
result: object result
returnCode(required): 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: string

Allowed Values: [ "UTF-8", "JSON", "base64" ]
message: string
payload:
status(required): string

Allowed Values: [ "valid", "invalid", "not found" ]

Transaction Status
txid(required): 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

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.