Open the Portico Developer Guide site
PosGateway Schema
CheckVoid Element
PosGateway Schema > PosRequest Element > Ver1.0 Element > Transaction Element : CheckVoid Element
Description

CheckVoid is used to cancel a previously successful CheckSale transaction. It can also be used to cancel a prior CheckSale transaction. This should be used in timeout situations or when a complete response is not received.

Note:CheckVoid transactions should be submitted within 31 days of the original transaction.

Note:If the CheckVoid also fails to return a complete response (likely due to a timeout), wait until connectivity is restored and try again or contact support to ensure the proper result was achieved. CheckQuery can be used to check the status of a prior CheckSale transaction.

Namespace http://Hps.Exchange.PosGateway
Type
PosCheckVoidReqType Complex Type
Diagram
Block1 Element Sequence CheckVoid Element
Overview
CheckVoid PosCheckVoidReqType Complex Type

CheckVoid is used to cancel a previously successful CheckSale transaction. It can also be used to cancel a prior CheckSale transaction. This should be used in timeout situations or when a complete response is not received.

Note:CheckVoid transactions should be submitted within 31 days of the original transaction.

Note:If the CheckVoid also fails to return a complete response (likely due to a timeout), wait until connectivity is restored and try again or contact support to ensure the proper result was achieved. CheckQuery can be used to check the status of a prior CheckSale transaction.

Sequence
Block1 CheckVoidReqBlock1Type Complex Type

Contains a series of required and optional elements

Note: GatewayTxnId and ClientTxnId are mutually exclusive, but it is required that one of these fields be provided.

All
GatewayTxnId optional txnIdType Simple Type

Gateway-generated transaction identifier returned in the response of the original transaction. This indicates the transaction to be updated.

ClientTxnId optional clientIdType Simple Type

Client generated transaction identifier sent in the request of the original transaction. This indicates the transaction to be updated.

Note: Client generated ids are critical for situations when the client never receives a response from the gateway.

Source
<xs:element name="CheckVoid" type="PosCheckVoidReqType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
      <p xmlns="http://Hps.Exchange.PosGateway">CheckVoid is used to cancel a previously successful CheckSale transaction.  It can also be used to cancel a prior CheckSale transaction. This should be used in timeout situations or when a complete response is not received.</p>
      <p xmlns="http://Hps.Exchange.PosGateway">
        <strong>Note:</strong>CheckVoid transactions should be submitted within 31 days of the original transaction.
                          </p>
      <p xmlns="http://Hps.Exchange.PosGateway">
        <strong>Note:</strong>If the CheckVoid also fails to return a complete response (likely due to a timeout), wait until connectivity is restored and try again or contact support to ensure the proper result was achieved.  CheckQuery can be used to check the status of a prior CheckSale transaction.
                          </p>
    </xs:documentation>
  </xs:annotation>
</xs:element>
See Also
Transaction ElementVer1.0 ElementPosRequest ElementPosGateway Schema