Soap API v1.6


Capture a queued transaction.


Move an authorized transaction into the current batch for settlement. It is possible to capture an amount other than the one originally authorized, however, you must follow the guidelines established by the merchant service bank. Capturing a higher or lower dollar amount could result in additional penalties and fees.

Most banks typically allow no more than 10 days to pass between the authorization/capture and settlement of a transaction.

If you do not wish to capture a previously authorized transaction, you may void the original authorization rather than capturing a 0 dollar amount, or simply allow the captured transaction to time out.

See also runTransaction, runQuickSale, voidTransaction, runCredit, runSale, runAuthOnly, getTransactionStatus


TransactionResponse captureTransaction ( ueSecurityToken Token, integer RefNum, double Amount, string IfAuthExpired )


Type Name Description
ueSecurityToken Token Merchant security token: used to identify merchant and validate transaction.
integer RefNum Unique transaction reference number assigned by the gateway.
double Amount Capture Amount if different from authorization
string IfAuthExpired Controls what will happen if the authorization has expired. Options are “Error” which will block the capture request; “ReAuth” which will attempt to reauthorize the funds; “Capture” which will ignore the authorization date and proceed with capture. If left blank, “Capture” will be assumed. The amount of time between an authorization expires is controlled by the “Expire Auths After” setting in the merchant console.

Return Value

TransactionResponse Returns a TransactionResponse object containing the results of the transaction and all relevant data.



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

try { 
//Initial Authorization
    'AccountHolder' => 'Tester Jones', 
    'Command' => 'authonly', 
    'Details' => array( 
      'Description' => 'Example Transaction', 
      'Amount' => '4.00', 
      'Invoice' => '44539' 
    'CreditCardData' => array( 
      'CardNumber' => '4444555566667779', 
      'CardExpiration' => '0919', 
      'AvsStreet' => '1234 Main Street', 
      'AvsZip' => '99281', 
      'CardCode' => '999' 
  $temp=$client->runTransaction($token, $Request); 
//Capturing the authorization
  $IfAuthExpired = 'ReAuth';
  $res=$client->captureTransaction($token,$temp->RefNum,$amount, $IfAuthExpired);  
catch (SoapFault $e) { 
  echo $client->__getLastRequest(); 
  echo $client->__getLastResponse(); 
  die("Capture Transaction failed :" .$e->getMessage()); 


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
        transaction.Details = New usaepay.TransactionDetail
        transaction.Details.Amount = "11.11"
        transaction.Details.AmountSpecified = "true"
        transaction.Details.Invoice = "123456"
        transaction.AuthCode = "009915"
        transaction.RefNum = "46993455"
        Dim response As usaepay.TransactionResponse = New usaepay.TransactionResponse
        response = client.captureTransaction(token, transaction.RefNum, transaction.Details.Amount)
        If response.ResultCode = "A" Then
            MsgBox("Transaction Approved, Refnum: " & response.RefNum)
            MsgBox("Transaction Error, Reason: " & response.Error)
        End If


usaepay.TransactionRequestObject tran = new usaepay.TransactionRequestObject();
            tran.Details = new usaepay.TransactionDetail();
            tran.Details.Amount = 1.00;
            tran.Details.AmountSpecified = true;
            tran.Details.Invoice = "123456";
            tran.RefNum = "47001545"; 
            usaepay.TransactionResponse response = new usaepay.TransactionResponse();
                response = client.captureTransaction(token, tran.RefNum, tran.Details.Amount);
                if (response.ResultCode == "A")
                    MessageBox.Show(string.Concat("Transaction Approved, RefNum: ",
                    MessageBox.Show(string.Concat("Transaction Failed: ",
            catch (Exception err)



<?xml version="1.0" encoding="UTF-8"?> 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="" xmlns:ns1="urn:usaepay"
 xmlns:xsd="" xmlns:xsi=""
   <Token xsi:type="ns1:ueSecurityToken">
   <ClientIP xsi:type="xsd:string"></ClientIP>
   <PinHash xsi:type="ns1:ueHash">
   <HashValue xsi:type="xsd:string">c420eb2f0a410bd1baab227b43c84b3ba7dad5ae</HashValue>
   <Seed xsi:type="xsd:string">11367276629-test</Seed>
   <Type xsi:type="xsd:string">sha1</Type>
    <SourceKey xsi:type="xsd:string">_B4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</SourceKey>
   <RefNum xsi:type="xsd:integer">102208900</RefNum>
   <Amount xsi:type="xsd:double">0</Amount>


<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="" xmlns:ns1="urn:usaepay"
 xmlns:xsd="" xmlns:xsi=""
      <captureTransactionReturn xsi:type="ns1:TransactionResponse">
        <AcsUrl xsi:type="xsd:string"></AcsUrl>
        <AuthAmount xsi:type="xsd:double">0</AuthAmount>
        <AuthCode xsi:type="xsd:string">066952</AuthCode>
        <AvsResult xsi:type="xsd:string">No AVS response(Typically no AVS data sent or swiped transaction)
        <AvsResultCode xsi:type="xsd:string"></AvsResultCode>
        <BatchNum xsi:type="xsd:integer">0</BatchNum>
        <BatchRefNum xsi:type="xsd:integer">0</BatchRefNum>
        <CardCodeResult xsi:type="xsd:string">No CVV2/CVC data available for transaction.</CardCodeResult>
        <CardCodeResultCode xsi:type="xsd:string"></CardCodeResultCode>
        <CardLevelResult xsi:type="xsd:string">Unknown Code</CardLevelResult>
        <CardLevelResultCode xsi:type="xsd:string"></CardLevelResultCode>
        <ConversionRate xsi:type="xsd:double">0</ConversionRate>
        <ConvertedAmount xsi:type="xsd:double">0</ConvertedAmount>
        <ConvertedAmountCurrency xsi:type="xsd:string">840</ConvertedAmountCurrency>
        <CustNum xsi:type="xsd:integer">0</CustNum>
        <Error xsi:type="xsd:string">Approved</Error>
        <ErrorCode xsi:type="xsd:integer">0</ErrorCode>
        <isDuplicate xsi:type="xsd:boolean">false</isDuplicate>
        <Payload xsi:type="xsd:string"></Payload>
        <RefNum xsi:type="xsd:integer">102208900</RefNum>
        <Result xsi:type="xsd:string">Approved</Result>
        <ResultCode xsi:type="xsd:string">A</ResultCode>
        <Status xsi:type="xsd:string">Pending</Status>
        <StatusCode xsi:type="xsd:string">P</StatusCode>
        <VpasResultCode xsi:type="xsd:string"></VpasResultCode>


This example uses the USAePay Java library. For directions on how to install the library and create the token/client objects, go to either the Java JAX-RPC Howto or the Java JAX-WS Howto.

try {
//Setting RefNum from the original transaction			
BigInteger RefNum = new BigInteger('12345678');
//Setting Amount to capture
Double Amount = new Double(12.34);
//Create Transaction Response
TransactionResponse Response;
Response = client.captureTransaction(token,RefNum,Amount);
} catch (Exception e) {
	System.out.println("Soap Exception: " + e.getMessage());

Change History

Version Change
1.5 Added the IfAuthExpired parameter
1.1 Method added prior to soap-1.1
developer/soap-1.6/methods/capturetransaction.txt · Last modified: 2016/02/17 14:54 by charlie

Page Tools