Get Transaction

METHOD NAME getTransaction

Requires state IDLE

Description

Get a transaction from the device. Method results considered success when the required transaction was found.

Parameters

object

• lookupMethod TransactionLookupMethod REQUIRED
  The query method to use to search for the required transaction
  (1) Show values

  1. TransactionLookupMethod

     Describe a method to query a transaction.

     • REF_ID query with transaction referenceId
     • TRANS_ID query with transaction transactionId
     • LAST_TRANS query the last transaction completed on the device. This may be either an approved or declined transaction.

• lookupValue string
  The value to search with according to the lookupMethod
  REQUIRED if lookupMethod is REF_ID or TRANS_ID

Result

object on success

• transactionResult Result
  The result of the transaction. Possible results are: OK, HOST_ERROR
  (1) Show values

  1. Result

     Result of new request. Each command has possible values in the field.

     • OK Request is ok
     • GENERAL_ERROR An error occurred
     • CANCELED Command was canceled either by the user (on-screen) or through cancel command,
     • TIMEOUT Operation was timed out.
     • HOST_ERROR Host returned an error regarding the request.
     • SMART_READER_ERROR An error occurred with the smart-reader
     • SMART_CARD_ERROR An error occurred with the smart card, or the reader couldn't communicate with the card.
     • NONE_CREDIT_CARD Industrial card was detected when performing a transaction.
     • CARD_NOT_ALLOWED When the detected card is not allowed to be processed

• transaction Transaction
  Transaction payload
  

Errors

• MissingParams
• InvalidParams
• IllegalState
• TransactionNotFound

Example

Request

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "method": "getTransaction",
  "params": {
        "lookupMethod": "REF_ID",
        "lookupValue": "abcdef123456"
    }
}

Response

{
    "jsonrpc": "2.0",
    "id": "1234567890",
    "result": {
        "transactionResult": "OK",
        "transaction": {
            "transactionStatus": "CAPTURED",
            "transactionTime": "2024-11-20T17:55:32.968+08:00",
            "referenceId": "abcdef123456",
            "terminalId": "0881198",
            "appVersion": "1.0.0-rc.7",
            "transactionType": "SALE",
            "amount": 1000,
            "totalAmount": 1000,
            "tipAmount": 0,
            "currency": 376,
            "transactionId": "24112017553208811987387",
            "authorizationNumber": "0792200",
            "rrn": "957179218   ",
            "systemTraceNumber": "01001001",
            "cardName": "ויזה רגיל",
            "maskedPan": "458008XXXXXX3303",
            "panSuffix": "3303",
            "terminalNo": 1,
            "creditTerms": "REGULAR",
            "panEntryMode": "EMV",
            "acquirer": 7,
            "acquirerName": "קארדקום",
            "acquirerBusinessNumber": "0010124",
            "acquirerPhoneNumber": "039999999",
            "issuer": 2,
            "issuerName": "כאל",
            "brand": 2,
            "brandName": "ויזה",
            "isClub": false,
            "isPrepaid": false,
            "cvvResponse": 0,
            "cardHolderIdResponse": 0,
            "cardHolderReceipt": {
                "fields": [
                    {
                        "id": "POS_NAME",
                        "key": "שם מסוף",
                        "value": "TESTדנגוט טסט"
                    },
                    {
                        "id": "POS_NUM",
                        "key": "מס מסוף",
                        "value": "0881198"
                    },
                    {
                        "id": "SOFTWARE_VERSION",
                        "key": "גרסת תוכנה",
                        "value": "100000"
                    },
                    {
                        "id": "MERCHANT_ID",
                        "key": "מס עסק",
                        "value": "0010124"
                    },
                    {
                        "id": "POS_TRAN_ID",
                        "key": "מס שובר",
                        "value": "01001001"
                    },
                    {
                        "id": "UID",
                        "key": "UID",
                        "value": "24112017553208811987387"
                    },
                    {
                        "id": "RRN",
                        "key": "RRN",
                        "value": "957179218"
                    },
                    {
                        "id": "TRAN_TYPE",
                        "key": "סוג עסקה",
                        "value": "חובה"
                    },
                    {
                        "id": "ISSUER_AUTH_NUM",
                        "key": "מס אישור",
                        "value": "0792200"
                    },
                    {
                        "id": "AUTH_BY",
                        "key": "גורם מאשר",
                        "value": "חברה"
                    },
                    {
                        "id": "ENTRY_MODE",
                        "key": "אופן ביצוע",
                        "value": "כרטיס חכם"
                    },
                    {
                        "id": "CREDIT_TERMS",
                        "key": "סוג אשראי",
                        "value": "רגיל"
                    },
                    {
                        "id": "CARD_NAME",
                        "key": "כרטיס",
                        "value": "ויזה רגיל"
                    },
                    {
                        "id": "CARD_NUMBER",
                        "key": "מס כרטיס",
                        "value": "XXXXXXXXXXXX3303"
                    },
                    {
                        "id": "AMOUNT",
                        "key": "סכום",
                        "value": "10.00   ש\"ח"
                    },
                    {
                        "id": "TRAN_DATE_TIME",
                        "key": "תאריך ושעה",
                        "value": "17:55 20/11/24"
                    },
                    {
                        "id": "AID",
                        "key": "AID",
                        "value": "A0000000031010"
                    },
                    {
                        "id": "ATC",
                        "key": "סידורי ש",
                        "value": "0034"
                    },
                    {
                        "id": "PSN",
                        "key": "סידורי כ",
                        "value": "01"
                    },
                    {
                        "id": "TSI",
                        "key": "TSI",
                        "value": "E800"
                    },
                    {
                        "id": "ARC",
                        "key": "ARC",
                        "value": "00"
                    },
                    {
                        "id": "TVR",
                        "key": "TVR",
                        "value": "0080001000"
                    },
                    {
                        "id": "VERIFIED_BY_PIN",
                        "key": "Verified by PIN"
                    }
                ],
                "language": "HEBREW"
            },
            "merchantReceipt": {
                "collectSignature": false,
                "collectTelephoneNo": false,
                "fields": [
                    {
                        "id": "POS_NAME",
                        "key": "שם מסוף",
                        "value": "TESTדנגוט טסט"
                    },
                    {
                        "id": "POS_NUM",
                        "key": "מס מסוף",
                        "value": "0881198"
                    },
                    {
                        "id": "SOFTWARE_VERSION",
                        "key": "גרסת תוכנה",
                        "value": "100000"
                    },
                    {
                        "id": "MERCHANT_ID",
                        "key": "מס עסק",
                        "value": "0010124"
                    },
                    {
                        "id": "POS_TRAN_ID",
                        "key": "מס שובר",
                        "value": "01001001"
                    },
                    {
                        "id": "UID",
                        "key": "UID",
                        "value": "24112017553208811987387"
                    },
                    {
                        "id": "RRN",
                        "key": "RRN",
                        "value": "957179218"
                    },
                    {
                        "id": "TRAN_TYPE",
                        "key": "סוג עסקה",
                        "value": "חובה"
                    },
                    {
                        "id": "ISSUER_AUTH_NUM",
                        "key": "מס אישור",
                        "value": "0792200"
                    },
                    {
                        "id": "AUTH_BY",
                        "key": "גורם מאשר",
                        "value": "חברה"
                    },
                    {
                        "id": "ENTRY_MODE",
                        "key": "אופן ביצוע",
                        "value": "כרטיס חכם"
                    },
                    {
                        "id": "CREDIT_TERMS",
                        "key": "סוג אשראי",
                        "value": "רגיל"
                    },
                    {
                        "id": "CARD_NAME",
                        "key": "כרטיס",
                        "value": "ויזה רגיל"
                    },
                    {
                        "id": "CARD_NUMBER",
                        "key": "מס כרטיס",
                        "value": "458008XXXXXX3303"
                    },
                    {
                        "id": "AMOUNT",
                        "key": "סכום",
                        "value": "10.00   ש\"ח"
                    },
                    {
                        "id": "TRAN_DATE_TIME",
                        "key": "תאריך ושעה",
                        "value": "17:55 20/11/24"
                    },
                    {
                        "id": "AID",
                        "key": "AID",
                        "value": "A0000000031010"
                    },
                    {
                        "id": "ATC",
                        "key": "סידורי ש",
                        "value": "0034"
                    },
                    {
                        "id": "PSN",
                        "key": "סידורי כ",
                        "value": "01"
                    },
                    {
                        "id": "TSI",
                        "key": "TSI",
                        "value": "E800"
                    },
                    {
                        "id": "ARC",
                        "key": "ARC",
                        "value": "00"
                    },
                    {
                        "id": "TVR",
                        "key": "TVR",
                        "value": "0080001000"
                    },
                    {
                        "id": "VERIFIED_BY_PIN",
                        "key": "Verified by PIN"
                    }
                ],
                "language": "HEBREW"
            }
        }
    }
}