updatePinpadTransactionStatus - Nayax Developer Portal

The updatePinpadTransactionStatus method reports the final status of a transaction after the device reads the card. Call it at the end of every transaction, using the pinpadCardDataId from the card reading stage. See Pinpad Mode for more on this flow. If the card was never read by the device, use updateExternalTransaction instead.

Update every transaction

Update the transaction status at the end of every transaction.
If you don’t update a transaction, it stays stuck in the database and triggers alerts on the Nayax side.
Log the update in your integration’s log file, so you can investigate it if needed.

Request

JSON-RPC 2.0All methods in TweezerComm follow a JSON-RPC 2.0 structure. See Get Started for 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 updatePinpadTransactionStatus.
The service must be set to engine in the params.

{
    "jsonrpc": "2.0",
    "method": "updatePinpadTransactionStatus",
    "id": "123454352",
    "params": [
        "engine",
        {
            "pinpadCardDataId": "62b1f4b9-e9bf-4643-986a-56d896ce655e",
            "tranResultStatus": 1,
            "processorTerminalId": "12345",
            "paymentMethodId": "1",
            "tranType": 1
        }
    ]
}

Request parameters

The table below describes the parameters of the request:

Name	Type	Description
`pinpadCardDataId`	string	Identifier the device returns when the card reading stage finishes. Find it in the responses of `startPinpadTransaction`, `doPinpadTransaction`, `endPinpadTransaction`, and `readCardForExternalTransaction`.
`tranResultStatus`	integer	Status of the transaction. `1` = Approved, `2` = Declined, `3` = Canceled.
`processorTerminalId`	string	Merchant ID for the processor terminal.
`paymentMethodId`	string	Payment method identifier. Currently only `1` (credit card) is supported.
`tranType`	integer	Transaction type code. See Transaction type values.

Transaction type values

The table below lists the values for tranType:

Value	Name
`1`	Sale
`2`	Refund
`3`	Pre-Authorization
`4`	Deferred Authorization
`5`	CNP
`6`	Pre-Authorization Completion
`7`	Void

​Request

​Request parameters

​Transaction type values

Request

Request parameters

Transaction type values