Refund

Payment Refund

Direction

POS → Terminal

This method is used by the POS to request a terminal to refund a payment that is after the void windows.

{
  "action": "payment",
  "method": "refund",
  "data": {
    "TerminalId": "",
    "RequestId": "",
    "Amount": {
      "Total": 0.0,
      "Currency": 840
    },
    "MerchantData": {
      "CustomKey": "CustomValue"
    }
  }
}

Refund 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": false
  }
}

Refund 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
    }
  }
}

Refund Payment Response

Direction

Terminal → POS

This response includes the refund result from the Payment API.

{
  "action": "payment",
  "method": "refund",
  "data": {
    "TerminalId": "",
    "RequestId": "",
    "TransactionId": "",
    "EventId": "",
    "Approved": false
  }
}