getStatus

The getStatus method returns the current AEA (Agamento Engine Application) service status and informs the client whether the payment engine is ready to process transactions (as opposed to getInternalStatus which provides information about the payment terminal's readiness to do the first part of processing a new transaction).
It is intended to be called infrequently (e.g., a few times per day) to check the operational state of the engine.

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 needs to be set to getReport, as shown in the example request below:

{
   "jsonrpc": "2.0",
   "method": "getStatus",
   "params": [
      "engine"
   ],
   "id": 1
}

Request Parameters

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

Name	Type	Description
`engine`	string	The fixed service name

Response

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

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

Response Parameters

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

Value	Description
`engineReady`	Engine is ready to process transactions
`engineNotEstablished`	No established setup exists (engine not initialized).
`engineReadyOnline`	Engine is ready, but all transactions are processed online due to the old DB.
`engineError`	General engine error (e.g., corrupted database).