Capture (SOAP)

Capture

The Capture operation is used to capture a single transaction for settlement after it has been successfully authorized by the Authorize operation.

In the Capture differenceData object, the Amount parameter should be equal to the new amount being captured.

For example:

Operation

Response Capture(string sessionToken, Capture differenceData, string applicationProfileId, string workflowId);

Parameters

Return Type

Exceptions

Code Snippets

public Response Capture(string sessionToken, Capture capture, string applicationProfileId, string workflowId)
{
  using (var client = new CwsTransactionProcessingClient(ConfigurationManager.AppSettings["Bindings.TxnSoap"]))
  {
    try
    {
      return client.Capture(sessionToken, capture, applicationProfileId, workflowId);
    }
    catch (FaultException ex)
    {
      SoapFaultHandler.HandleFaultException(ex);
    }
  }
}

/* $transactionID is the known transaction ID of a previous transaction
 * $amount is the amount of money to charge, leave it empty to charge existing amount
 * $tip_amount is the amount of tip money to charge, leave it empty to charge existing amount*/
 
public function capture($transactionID, $creds = null, $amount = null, $tip_amount = null)
{
  if (! $this->signOn ())
    return false;
 
  $cap = new BankcardCapture ();
  $cap->TransactionId = $transactionID;
  $cap->Amount = $amount;
  $cap->TipAmount = $tip_amount;
  if ($creds != null)
  {
    $cap->Addendum = new Addendum ();
    $cap->Addendum->Unmanaged = new Unmanaged ();
    $cap->Addendum->Unmanaged->Any = new Any ();
    $cap->Addendum->Unmanaged->Any->string = $creds;
  }
 
  // Build Capture
  $trans = new CaptureAuth ();
  $trans->sessionToken = $this->session_token;
  $trans->differenceData = $cap;
  $trans->merchantProfileId = $this->merchantProfileID;
  $trans->workflowId = $this->workflowId;
  $trans->applicationProfileId = $this->appProfileID;
 
  try
  {
    $capResponse = $this->bankCard->Capture ( $trans )->CaptureResult;
    //echo ('
'.$this->bankCard->__getLastRequestHeaders());
    //echo ('
'.$this->bankCard->__getLastRequest());
    /*echo ('
'.$this->bankCard->__getLastResponseHeaders());
     echo ('
'.$this->bankCard->__getLastResponse());*/
    return $capResponse;
  }
  catch ( SoapFault $e )
  {
    echo "
REQUEST:\n" . $this->bankCard->__getLastRequest() . "\n
";
    process_soap_error ( $e );
    echo 'SERVER ERROR: Error trying to Capture.
';
    $xmlFault = $this->bankCard->__getLastResponse ();
    $errors = handleTxnFault ( $e, $xmlFault );
    echo $errors;
    exit ();
  }
}

CaptureAll

The CaptureAll operation is used to flag all transactions for settlement that have been successfully authorized using the Authorize operation. Merchants may wish to invoke this operation to ensure all transactions are included in the batch that is sent for settlement processing by the cut-off times established by the service provider or to transmit smaller batches to the service provider for settlement.

In addition, when performing CaptureAll on terminal capture hosts, settlement times of up to 5 minutes or more are not uncommon depending on the number of transactions in the batch. Client applications need to anticipate and account for longer settlement processing times in their time-out management schemes.

In the Capture differenceData object, the Amount parameter should be equal to the new amount being captured.

For example:

Operation

List&lt;Response&gt; CaptureAll(string sessionToken, List&lt;Capture&gt; differenceData, List&lt;String&gt; batchIds, string applicationProfileId, <em>MerchantProfile merchantProfile</em>, string merchantProfileId, string workflowId);

Parameters

Return Type

Exceptions

Code Snippets

public List CaptureAll(string sessionToken, List captures, string applicationProfileId, string merchantProfileId, string workflowId, List batchIds = null)
{
  Type type = typeof(T);
 
  if (_msgFormat == MessageFormat.SOAP.ToString())
  {
    var bankcardCaptures = new List();
    var regularCaptures = new List();
    if (type == typeof(BankcardCapture))
    {
      foreach (var capture in captures)
      {
        bankcardCaptures.Add(capture as BankcardCapture);
      }
    }
    else
    {
      foreach (var capture in captures)
      {
        regularCaptures.Add(capture as Capture);
      }
    }
  using (var client = new CwsTransactionProcessingClient(ConfigurationManager.AppSettings["Bindings.TxnSoap"]))
  {
    try
    {
      if(bankcardCaptures.Count > 0 && batchIds != null)
        return client.CaptureAll(sessionToken, bankcardCaptures.ToArray(), batchIds.ToArray(), applicationProfileId, merchantProfileId, workflowId).ToList();
      if(bankcardCaptures.Count > 0)
        return client.CaptureAll(sessionToken, bankcardCaptures.ToArray(), null, applicationProfileId, merchantProfileId, workflowId).ToList();
      if(batchIds != null)
        return client.CaptureAll(sessionToken, regularCaptures.ToArray(), batchIds.ToArray(), applicationProfileId, merchantProfileId, workflowId).ToList();
      return client.CaptureAll(sessionToken, regularCaptures.ToArray(), null, applicationProfileId, merchantProfileId, workflowId).ToList();
    }
    catch (FaultException ex)
    {
      SoapFaultHandler.HandleFaultException(ex);
    }
  }
}

/* $differenceData is an object that contains any data to adjust at the time of settlement */
 
public function captureAll($differenceData, $creds = null)
{
  if (! $this->signOn ())
    return false;
 
  if ($this->svc instanceof BankcardService)
  {
    $diffDataArray = array ();
    $caDiffData = new CaptureDifferenceData ();
 
    if ($differenceData != null)
    {
      $i = 0;
      if (is_array ( $differenceData ))
      {
        foreach ( $diffData as $differenceData )
        {
          $caDiffData->TransactionId = $diffData->transactionID;
          $caDiffData->Amount = $diffData->amount;
          $caDiffData->TipAmount = $diffData->tip_amount;
          $caDiffData->ShipDate = $diffData->shipDate;
          $diffDataArray [] = $caDiffData;
        }
      }
      else
      {
        $caDiffData->TransactionId = $diffData->transactionID;
        $caDiffData->Amount = $diffData->amount;
        $caDiffData->TipAmount = $diffData->tip_amount;
        $caDiffData->ShipDate = $diffData->shipDate;
        $diffDataArray [] = $caDiffData;
      }
      if ($creds != null)
      {
        $diffDataArray [0]->Addendum = new Addendum ();
        $diffDataArray [0]->Addendum->Unmanaged = new Unmanaged ();
        $diffDataArray [0]->Addendum->Unmanaged->Any = new Any ();
        $diffDataArray [0]->Addendum->Unmanaged->Any->string = $creds;
      }
    }
  }
 
  if ($creds != null)
  {
    $diffDataArray = array ();
    $caDiffData = new CaptureDifferenceData ();
    $caDiffData->TransactionId = '-1';
    $diffDataArray [] = $caDiffData;
    $diffDataArray [0]->Addendum = new Addendum ();
    $diffDataArray [0]->Addendum->Unmanaged = new Unmanaged ();
    $diffDataArray [0]->Addendum->Unmanaged->Any = new Any ();
    $diffDataArray [0]->Addendum->Unmanaged->Any->string = $creds;
  }
 
  // Build Capture
  $trans = new CaptureAll ();
  $trans->sessionToken = $this->session_token;
  $trans->differenceData = $diffDataArray;
  $trans->merchantProfileId = $this->merchantProfileID;
  $trans->workflowId = $this->workflowId;
  $trans->applicationProfileId = $this->appProfileID;
 
  try
  {
    $capAllResponse = $this->bankCard->CaptureAll ( $trans )->CaptureAllResult;
    //echo ('
'.$this->bankCard->__getLastRequestHeaders());
    //echo ('
'.$this->bankCard->__getLastRequest());
    //echo ('
'.$this->bankCard->__getLastResponseHeaders());
    //echo ('
\n'.$this->bankCard->__getLastResponse().'\n');
    return $capAllResponse;
  }
  catch ( SoapFault $e )
  {
    /*echo "
REQUEST:\n" . $this->bankCard->__getLastRequest() . "\n
";*/
    //process_soap_error ( $e );
    echo 'SERVER ERROR: Error trying to Capture.
';
    echo ('
'.$this->bankCard->__getLastRequest());
    $xmlFault = $this->bankCard->__getLastResponse ();
    $errors = handleTxnFault ( $e, $xmlFault );
    echo $errors;
    exit ();
  }
}