Capture

Direction

POS → Terminal

This method is used by the POS to request a terminal to capture a payment. This is done when it was requested with "method" = "auth".

{
  "action": "payment",
  "method": "capture",
  "data": {
    "TerminalId": "",
    "RequestId": "", // Either RequestId or TransactionId is required
    "TransactionId": "", // Either TransactionId or RequestId is required
    "Amount": {
      "Total": 0.0,
      "Tip": 0.0,
      "Fee": 0.0,
      "Currency": 840
    },
    "TerminalFunctions": {
      "Tip": {
        "Enabled": false,
        "Low": 0.0,
        "Mid": 0.0,
        "High": 0.0
      },
      "Fee": {
        "Enabled": false,
        "Amount": 0.0,
        "Percent": 0.0,
        "Description": ""
      }
    },
    "MerchantData": {
      "CustomKey": "CustomValue"
    }
  }
}

Capture Acknowledge Response

Direction

Terminal → POS

This method is used by the terminal to notify that it has accepted/declined a payment request. The RequestId is the payment identifier used by the terminal for tracking through the payment process.

{
  "action": "payment",
  "method": "acknowledge",
  "data": {
    "PosId": "",
    "RequestId": "",
    "Approved": true
  }
}

Capture Processing Response

Direction

Terminal → POS

This method is used by the terminal to notify the POS that it has sent a payment request to the processor and is awaiting a response.

{
  "action": "payment",
  "method": "processing",
  "data": {
    "PosId": "",
    "RequestId": "",
    "Approved": false,
    "Amount": {
      "Total": 0.0,
      "Tip": 0.0,
      "Fee": 0.0,
      "Currency": 840
    }
  }
}

Capture Payment Response

Direction

Terminal → POS

This response includes the capture result from the Payment API.

{
  "action": "payment",
  "method": "capture",
  "data": {
    "PosId": "",
    "TerminalId": "",
    "RequestId": "",
    "TransactionId": "",
    "EventId": "",
    "Approved": true,
    "EntryMode": "", // contactless_chip, manual
    "PaymentType": "", // Visa, Mastercard, Amex, Discover
    "LastFour": "",
    "ResponseText": "",
    "Amount": {
      "Total": 0.0,
      "Currency": 840,
    },
    "MerchantData": {
      "CustomKey": "CustomValue",
    },
  },
}