Query

Payment Query

Direction

POS → Terminal

This method is used by the POS to request a terminal to lookup/verify a transaction. This is mainly used when there is an error and the POS wants to verify that a transaction might have completed without being notified.

{
  "action": "payment",
  "method": "query",
  "data": {
    "TerminalId": "",
    "PaymentId": ""
  }
}

Payment Query Result

Direction

Terminal → POS

{
  "action": "payment",
  "method": "query",
  "data": {
    "PosId": "",
    "TerminalId": "",
    "PaymentId": "",
    "Approved": false,
    "Amount": {
      "Total": 0.0,
      "Tip": 0.0,
      "Fee": 0.0,
      "Currency": 840
    },
    "PaymentType": "", // [visa, mastercard, ach, bitcoin...]
    "PaymentInfo": "", // last 4
    "EntryMode": "", // [manual, swipe, chip, contactless]
    "ResponseText": "",
    "MerchantData": {
      "CustomKey": "CustomValue",
      "TransactionId": "ProcessorTransactionId"
    }
  }
}