getStatus

The getStatus method checks the status of the AEA (the payment application) to see if it's ready to process transactions. It's a quick way to diagnose the terminal's health, but you should call it infrequently.

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, ensure to configure the following:

  • The method field must be set to getStatus.
  • The service must be set to ashrait in the params.
{
    "jsonrpc": "2.0",
    "method": "getStatus",
    "params": [
        "ashrait"
    ],
    "id": 1
}

Request Parameters

This method doesn't require any parameters beyond the standard service name.

Response

A successful call returns a string indicating the current status of the payment application.

{
    "jsonrpc": "2.0",
    "result": "ashraitReady",
    "id": 1
}

Response Parameters

The table below describes the response parameters for this method.

ValueDescription
ashraitReadyReady for transactions.
ashraitNotEstablishedThe terminal setup hasn't been completed.
ashraitReadyOnlineReady, but all transactions will be processed online due to an old database.
ashraitErrorA general error occurred (e.g., a corrupted database).
ashraitNotReadyNot ready for transactions.