abortReadCard

The abortReadCard method is used to cancel an ongoing readCard operation. This is helpful when the user wants to stop card reading before it completes, such as during a timeout, user cancellation, or application logic control.

Request

📘

JSON-RPC 2.0

All methods in TweezerComm follow a JSON-RPC 2.0 structure. See Get Startedfor more details on how the requests are structured and sent.

In the request, the method field should be set to abortReadCard, and the params must include the fixed value device:

{
    "jsonrpc": "2.0",
    "method": "abortReadCard",
    "id": "123454352",
    "params": [
        "device"
    ]
}

Request Parameters

See the table below for a description of the available request parameters for this method.

NameTypeDescription
paramsarrayMust contain the value device

Response

A successful request will return a response similar to the one in the code block below:

{
    "jsonrpc": "2.0",
    "id": "123454352",
    "result": {
        "statusCode": 0,
        "statusMessage": "ok"
    }
}

Response Parameters

Below is a table with all the possible response parameters and their description:

NameTypeDescription
statusCodeintegerOperation status (0 = success)
statusMessagestringOperation result message