getReport

The getReport method is used to retrieve service transaction reports. It provides a way to query various transaction records, including mini-settlement transactions, pre-authorization transactions, and deferred authorization transactions. This allows client applications to access transaction summaries based on their processing stage.

  • This method is less relevant for the Global payment method due to the nature of how transactions are processed: Globally, each completed transaction that is saved on the payment terminal is sent immediately to the Engine and gets the final settlement. Whereas in Israel, each completed transaction that is saved on the payment terminal and is kept until the end of day and only then there's a bulk transmission (doPeriodic) of all of the transactions done that day to Ashrait and only then they are finally settled.

    getReport is used in order to query the information that are saved on the payment terminal- so globally there wouldn't be any transactions saved there (that have not already reached 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": "getReport",
    "id": "123454352",
    "params": [
        "engine", "miniSettlementTransactions"
    ]
}

Request Parameters

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

Name

Type

Description

action

string

The type of transaction report to retrieve. Available values:

  • miniSettlementTransactions: Mini settlement transactions report
  • queryPreAuthTransactions: Query pre-auth transactions report
  • queryDeferredAuthTransactions: Query deferred auth transactions report

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,
        "queriedTransactions": [
            "414d5aca-3df9-46aa-8c20-86d1685da885",
            "526ecaca-3df9-46aa-8c20-8456185da885"
        ]
    }
}

Response Parameters

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

NameTypeDescription
statusCodeintegerThe operation status (0 = success)
statusMessagestringOperation message
queriedTransactionsarrayA list of queried transaction identifiers.