XML VoidTransaction Action

This will void any sale, credit, or refund transaction if processed prior to the daily batch settlement. The OperationXID field should contain the XID for the original transaction. The example below displays all fields that could potentially be used for this action - including the optional fields which are specified.

Optional Fields

TransactionControl elements
 

VendorData elements
 

Example

<?xml version="1.0"?> 
<GatewayInterface> 
    <APICredentials> 
        <Username>username</Username> 
        <PayloadSignature>EXAMPLESIGNATURE</PayloadSignature> 
        <TargetGateway>12345</TargetGateway> 
    </APICredentials> 
    <VoidTransaction> 
        <OperationXID>12345678</OperationXID>
<!-- All TransactionControl elements are optional including TransactionControl --> 
         <TransactionControl> 
          <SendCustomerEmail>TRUE</SendCustomerEmail> <!-- TRUE/FALSE --> 
          <SendMerchantEmail>TRUE</SendMerchantEmail> <!-- TRUE/FALSE --> 
          <TestMode>TRUE</TestMode> <!-- TRUE/FALSE --> 
           <EmailText> <!-- Up to 10 EmailTextItem elements allowed --> 
           <EmailTextItem>test1</EmailTextItem> 
           <EmailTextItem>test1</EmailTextItem> 
           <EmailTextItem>test1</EmailTextItem> 
           <EmailTextItem>test1</EmailTextItem> 
           <EmailTextItem>test1</EmailTextItem> 
           <EmailTextItem>test1</EmailTextItem> 
           <EmailTextItem>test1</EmailTextItem> 
           <EmailTextItem>test1</EmailTextItem> 
           <EmailTextItem>test1</EmailTextItem> 
           <EmailTextItem>test1</EmailTextItem> 
          </EmailText> 
         </TransactionControl> 
<!-- Optional. This information will be saved on our servers and is 
available in the XML transaction report. This is useful if you want 
to save your own transaction meta-data with a transaction. --> 
         <VendorData> 
          <Element> 
           <Name>repId</Name> 
           <Value>1234567</Value> 
          </Element> 
         </VendorData> 
    </VoidTransaction> 
</GatewayInterface>

For additional information, please view the XML API Connection documentation HERE.

 

 

Sidebar Heading

Sidebar Subheading

Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin vitae lacus et massa viverra dictum.

Sidebar Subheading

Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin vitae lacus et massa viverra dictum