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.

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

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:

Name	Type	Description
`statusCode`	integer	The operation status (0 = success)
`statusMessage`	string	Operation message
`queriedTransactions`	array	A list of queried transaction identifiers.