developer:soap-1.4:methods:voidtransaction

Soap API v1.4

voidTransaction

Void a specific transaction.

Description

This function will void a transaction that was previously authorized. Once a transaction has been voided, it will not show up on the customer's credit card statement. Customers who have online banking that allows them to see “Pending” transactions may see the voided transaction for a few days before it disappears.

You can only void a transaction that hasn't been settled yet. A transaction is settled when the batch that it is in has been closed. If the transaction has been settled, you must run a credit instead using the runCredit method. If you run a credit, both the credit and the initial charge will show up on the customer's credit card statement. (See the runCredit method for more details.)

The transaction to be voided must be retrieved using the reference number (RefNum) assigned to the transaction by the gateway. The RefNum is assigned by the gateway and returned when a transaction is processed. To find a missing RefNum, use the searchTransactions method.

See also runTransaction, runQuickSale, runCredit, runSale, runauthOnly, getTransactionStatus

Syntax

boolean voidTransaction ( ueSecurityToken Token, integer RefNum )

Arguments

Type Name Description
ueSecurityToken Token Merchant security token: used to identify merchant and validate transaction.
integer RefNum Transaction Reference number assigned by the gateway.

Return Value

boolean Returns confirmation of request only if successful. If request fails, an exception will be thrown.

Examples

PHP

For directions on how to set up the WSDL link, create “$token” and “$client”, go to PHP Soap How-to.

<?php 
 
try { 
 
  $Request=array( 
    'AccountHolder' => 'Tester Jones', 
    'Command' => 'authonly', 
    'Details' => array( 
      'Description' => 'Example Transaction', 
      'Amount' => '4.00', 
      'Invoice' => '44539' 
      ), 
    'CreditCardData' => array( 
      'CardNumber' => '4444555566667779', 
      'CardExpiration' => '0909', 
      'AvsStreet' => '1234 Main Street', 
      'AvsZip' => '99281', 
      'CardCode' => '999' 
      ) 
    ); 
 
  $temp=$client->runTransaction($token, $Request); 
 
  $res=$client->voidTransaction($token,$temp->RefNum);  
 
  print_r($res); 
 
} 
 
catch (SoapFault $e) { 
  die("Void Transaction failed :" .$e->getMessage()); 
  } 
 
?>

VB

For directions on how to set up the WSDL link and create the “token” and “client” variables, go to the Visual Basic .Net Soap How-to.

    Dim client As usaepay.usaepayService = New usaepay.usaepayService
        Dim token As usaepay.ueSecurityToken
 
        token = Me.CreateToken("714SSUxv1uohng2XkMJ7kLpETsu58G66", "1234")
 
        Dim transaction As usaepay.TransactionRequestObject = New usaepay.TransactionRequestObject
        Dim refnum As String
        Dim void As Boolean
 
        refnum = "46980114"
 
        void = True
 
        Dim result As Boolean
 
        result = client.voidTransaction(token, refnum)
 
        If result = True Then
            MsgBox("Transaction Voided")
        Else
            MsgBox("An error occured.")
        End If

.NET C#

For directions on how to set up the WSDL link and create the “token” and “client” variables, go to the C Sharp .Net Soap How-to.

            string refnum;
            Boolean response;
 
            refnum = "46973526";
 
            try
            {
                response = client.voidTransaction(token, refnum);
 
                if (response == true)
                {
                    MessageBox.Show(string.Concat("Transaction voided"));
                }
                else
                {
                    MessageBox.Show(string.Concat("An error occured"));
                }
            }
            catch (Exception err)
            {
                MessageBox.Show(err.Message);
 
            }

XML

<?xml version="1.0" encoding="UTF-8"?> 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:ns1="urn:usaepay" xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" 
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> 
<SOAP-ENV:Body> 
<ns1:voidTransaction> 
<Token xsi:type="ns1:ueSecurityToken">
<ClientIP xsi:type="xsd:string">192.168.0.1</ClientIP>
<PinHash xsi:type="ns1:ueHash">
<HashValue xsi:type="xsd:string">11ac55b0a0b59f8f028dbf85bc32266fa973dd0e</HashValue>
<Seed xsi:type="xsd:string">12678150211876663375</Seed>
<Type xsi:type="xsd:string">sha1</Type>
</PinHash>
<SourceKey xsi:type="xsd:string">HB4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</SourceKey>
</Token>
<RefNum xsi:type="xsd:integer">1118275</RefNum> 
</ns1:voidTransaction> 
</SOAP-ENV:Body> 
</SOAP-ENV:Envelope>

Change History

Version Change
1.1 Method added prior to soap-1.1
developer/soap-1.4/methods/voidtransaction.txt · Last modified: 2010/08/30 17:12 by epouchak

Page Tools