Soap API v1.3


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, Amount )


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

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' => '0909', 
      'AvsStreet' => '1234 Main Street', 
      'AvsZip' => '99281', 
      'CardCode' => '999' 
  $temp=$client->runTransaction($token, $Request); 
//Capturing the authorization
  $res=$client->captureTransaction($token,$temp->RefNum,$amount );  
catch (SoapFault $e) { 
  echo $client->__getLastRequest(); 
  echo $client->__getLastResponse(); 
  die("Capture Transaction failed :" .$e->getMessage()); 


    Dim client As usaepay.usaepayService = New usaepay.usaepayService
    Dim token As usaepay.ueSecurityToken
    token = Me.CreateToken("982lz9VsLm87MA54Sv8E582h8OZMArL6", "443311")
    Dim transaction As usaepay.TransactionRequestObject = New usaepay.TransactionRequestObject
      transaction.Details = New usaepay.TransactionDetail
      transaction.Details.Amount = "9.02"
      transaction.Details.AmountSpecified = True
      transaction.Details.Invoice = "434534"
    transaction.AuthCode = "035786"
    transaction.RefNum = "46405618"
    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 = "46998377"; 
            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="" 
xmlns:SOAP-ENC="" SOAP-ENV:encodingStyle="">
<Token xsi:type="ns1:ueSecurityToken">
<ClientIP xsi:type="xsd:string"></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>
<SourceKey xsi:type="xsd:string">HB4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</SourceKey>
<RefNum xsi:type="xsd:integer">177635768</RefNum>
<Amount xsi:type="xsd:double">45.99</Amount>


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());
developer/soap-1.3/methods/capturetransaction.txt · Last modified: 2010/08/26 15:48 by irina

Page Tools