Captures

Use this service to capture an authorized payment. Partial captures and full-amount captures are both supported.

Endpoints

Set the
apCaptureService_run
 field to
true
, and send the request to one of these endpoints:
Production:
https://ics2ws.ic3.com/commerce/1.x/transactionProcessor
Test:
https://ics2wstest.ic3.com/commerce/1.x/transactionProcessor

Response Status

The capture service responds with one of these statuses as the
apCaptureReply_status
 response field value:
  • FAILED
    : The capture request failed.
  • PENDING
    : The capture request is accepted but is not captured. Request the check status service to retrieve status updates.
  • SETTLED
    : The capture request is settled for the requested amount.
The capture service also responds with a reason code as the
apCaptureReply_reasonCode
 field value.

Required Fields for Capturing an Authorization

Example: Capturing an Authorization with XML

Light Dark
Request
123456789101112
<="urn:schemas-cybersource-com:transaction-data-1.213">
   <merchantID>test_merchant</merchantID>
   <merchantReferenceCode>refnum-1234</merchantReferenceCode>
   <purchaseTotals>
      <currency>USD</currency>
      <grandTotalAmount>1</grandTotalAmount>
   </purchaseTotals>
   <apPaymentType>afp</apPaymentType>
   <apCaptureService run="true">
	<authRequestID>6246274241256683803069</authRequestID>
   </apCaptureService>
</>
Response to a Successful Request
123456789101112131415161718
<:c="urn:schemas-cybersource-com:transaction-data-1.213">
   <merchantReferenceCode>refnum-1234</merchantReferenceCode>
   <requestID>6246277717236180203285</requestID>
   <decision>ACCEPT</decision>
   <reasonCode>100</reasonCode>
   <purchaseTotals>
      <currency>USD</currency>
   </purchaseTotals>
   <apCaptureReply>
      <reasonCode>100</reasonCode>
      <status>SETTLED</status>
      <processorResponse>00004</processorResponse>
      <amount>1.00</amount>
      <reconciliationID>XFZOSQ97H6UE</reconciliationID>
      <paymentStatus>settled</paymentStatus>
      <responseCode>00004</responseCode>
   </apCaptureReply>
</>