Capture

Payment 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": "",
    "PaymentId": "",
    "Amount": {
      "SubTotal": 0.0,
      "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"
    }
  }
}

Payment Capture Result

Direction

Terminal → POS

This method is the actual payment result from the AUTH API.

{
  "action": "payment",
  "method": "capture",
  "data": {
    "RequestId": "",
    "TransactionId": "",
    "EventId": "",
    "Approved": false,
    "ResponseText": "",
    "MerchantData": {
      "CustomKey": "CustomValue"
    }
  }
}