Capture Request

You must structure a Capture request as shown in the following examples. The structure of the request is identical for either an Online or a Batch submission.

<capture id="Capture Id" reportGroup="iQ Report Group" customerId="Customer Id" partial="false">

  <cnpTxnId>Transaction Id</cnpTxnId>

   <orderId>New order Id</orderId>

  <amount>Authorization Amount</amount>

  <surchargeAmount>Surcharge Amount</surchargeAmount>

  <enhancedData>

  <processingInstructions>

  <payPalOrderComplete>Set to true for final Capture</payPalOrderComplete>

  <payPalNotes>Notes</paypalNotes>

  <lodgingInfo>

<pin>Gift Card Pin Number</pin

  <passengerTransportData>

  <foreignRetailerIndicator>F</foreignRetailerIndicator>

<partialCapture>

</capture>

Example:  Batch Capture Request - Full Capture

The following Capture example is for a full capture. Although the <capture> element includes an <amount> child, it is not required for a full Capture. If you omit the <amount> child element, the capture amount defaults to the full amount from the associated Authorization.

<cnpRequest version="12.0" xmlns="http://www.vantivcnp.com/schema" id="123" numBatchRequests="1">

  <authentication>

    <user>userName</user>

    <password>password</password>

  </authentication>

  <batchRequest id="01234567" numAuths="0" authAmount="0" numCaptures="1" captureAmount="55814" numCredits="0" creditAmount="0" numSales="0" saleAmount="0" merchantId="100">

    <capture id="AX54325432" reportGroup="RG12" partial="false">

      <cnpTxnId>84568457</cnpTxnId>

      <amount>55814</amount>

      <enhancedData>

        <customerReference>PO12346</customerReference>

        <salesTax>1500</salesTax>

        <taxExempt>false</taxExempt>

        <discountAmount>0</discountAmount>

        <shippingAmount>3714</shippingAmount>

        <dutyAmount>0</dutyAmount>

        <shipFromPostalCode>01851</shipFromPostalCode>

        <destinationPostalCode>01851</destinationPostalCode>

        <destinationCountryCode>USA</destinationCountryCode>

        <invoiceReferenceNumber>123456</invoiceReferenceNumber>

        <orderDate>2011-09-14</orderDate>

        <detailTax>

          <taxIncludedInTotal>true</taxIncludedInTotal>

          <taxAmount>500</taxAmount>

          <taxRate>0.01667</taxRate>

          <taxTypeIdentifier>00</taxTypeIdentifier>

          <cardAcceptorTaxId>011234567</cardAcceptorTaxId>

        </detailTax>

        <lineItemData>

          <itemSequenceNumber>1</itemSequenceNumber>

          <itemDescription>table</itemDescription>

          <productCode>TB123</productCode>

          <quantity>1</quantity>

          <unitOfMeasure>EACH</unitOfMeasure>

          <taxAmount>1500</taxAmount>

          <lineItemTotal>30000</lineItemTotal>

          <lineItemTotalWithTax>31500</lineItemTotalWithTax>

          <itemDiscountAmount>0</itemDiscountAmount>

          <commodityCode>301</commodityCode>

          <unitCost>300.00</unitCost>

          <detailTax>

            <taxIncludedInTotal>true</taxIncludedInTotal>

            <taxAmount>500</taxAmount>

            <taxRate>0.01667</taxRate>

            <taxTypeIdentifier>03</taxTypeIdentifier>

            <cardAcceptorTaxId>011234567</cardAcceptorTaxId>

          </detailTax>

        </lineItemData>

        <lineItemData>

          <itemSequenceNumber>2</itemSequenceNumber>

          <itemDescription>chair</itemDescription>

          <productCode>CH123</productCode>

          <quantity>1</quantity>

          <unitOfMeasure>EACH</unitOfMeasure>

          <lineItemTotal>20000</lineItemTotal>

          <itemDiscountAmount>0</itemDiscountAmount>

          <commodityCode>301</commodityCode>

          <unitCost>200.00</unitCost>

        </lineItemData>

      </enhancedData>

    </capture>

  </batchRequest>

</cnpRequest>

Example:  Batch Capture Request - Partial Capture

A partial Capture has the partial attribute set to true and must include an amount child element.

<cnpRequest version="12.0" xmlns="http://www.vantivcnp.com/schema" id="123" numBatchRequests="1">

  <authentication>

    <user>userName</user>

    <password>password</password>

  </authentication>

  <batchRequest id="01234567" numAuths="0" authAmount="0" numCaptures="1" captureAmount="45814" numCredits="0" creditAmount="0" numSales="0" saleAmount="0" merchantId="100">

  <capture id="AX54325432" reportGroup="RG12" partial="true">

    <cnpTxnId>84568457</cnpTxnId>

    <amount>45814</amount>

    <enhancedData>

      <customerReference>PO12346</customerReference>

      <salesTax>2100</salesTax>

      <taxExempt>false</taxExempt>

      <discountAmount>0</discountAmount>

      <shippingAmount>3714</shippingAmount>

      <dutyAmount>0</dutyAmount>

      <shipFromPostalCode>01851</shipFromPostalCode>

      <destinationPostalCode>01851</destinationPostalCode>

      <destinationCountryCode>USA</destinationCountryCode>

      <invoiceReferenceNumber>123456</invoiceReferenceNumber>

      <orderDate>2016-09-14</orderDate>

      <detailTax>

        <taxIncludedInTotal>true</taxIncludedInTotal>

        <taxAmount>500</taxAmount>

        <taxRate>0.01667</taxRate>

        <taxTypeIdentifier>00</taxTypeIdentifier>

        <cardAcceptorTaxId>011234567</cardAcceptorTaxId>

      </detailTax>

      <lineItemData>

        <itemSequenceNumber>1</itemSequenceNumber>

        <itemDescription>table</itemDescription>

        <productCode>TB123</productCode>

        <quantity>1</quantity>

        <unitOfMeasure>EACH</unitOfMeasure>

        <taxAmount>1500</taxAmount>

        <lineItemTotal>30000</lineItemTotal>

        <lineItemTotalWithTax>31500</lineItemTotalWithTax>

        <itemDiscountAmount>0</itemDiscountAmount>

        <commodityCode>301</commodityCode>

        <unitCost>300.00</unitCost>

        <detailTax>

          <taxIncludedInTotal>true</taxIncludedInTotal>

          <taxAmount>500</taxAmount>

          <taxRate>0.01667</taxRate>

          <taxTypeIdentifier>03</taxTypeIdentifier>

          <cardAcceptorTaxId>011234567</cardAcceptorTaxId>

        </detailTax>

      </lineItemData>

      <lineItemData>

          <itemSequenceNumber>2</itemSequenceNumber>

          <itemDescription>chair</itemDescription>

          <productCode>CH123</productCode>

          <quantity>1</quantity>

          <unitOfMeasure>EACH</unitOfMeasure>

          <lineItemTotal>20000</lineItemTotal>

          <itemDiscountAmount>0</itemDiscountAmount>

          <commodityCode>301</commodityCode>

          <unitCost>200.00</unitCost>

        </lineItemData>

      </enhancedData>

    </capture>

  </batchRequest>

</cnpRequest>

Example:  Online Capture Request - Full Capture

The following Capture example is for a full capture. Although the <capture> element includes an <amount> child, it is not required for a full Capture. If you omit the <amount> child element, the capture amount defaults to the full amount from the associated Authorization.

<cnpOnlineRequest version="12.0" xmlns="http://www.vantivcnp.com/schema" merchantId="100">

  <authentication>

    <user>User Name</user>

    <password>password</password>

  </authentication>

  <capture id="2" reportGroup="ABC Division" customerId="038945" partial="false">

    <cnpTxnId>13254123434</cnpTxnId>

    <enhancedData>

      <customerReference>PO12345</customerReference>

      <salesTax>125</salesTax>

      <taxExempt>false</taxExempt>

      <discountAmount>0</discountAmount>

      <shippingAmount>495</shippingAmount>

      <dutyAmount>0</dutyAmount>

      <shipFromPostalCode>01851</shipFromPostalCode>

      <destinationPostalCode>01851</destinationPostalCode>

      <destinationCountryCode>USA</destinationCountryCode>

      <invoiceReferenceNumber>123456</invoiceReferenceNumber>

      <orderDate>2011-08-14</orderDate>

      <detailTax>

        <taxIncludedInTotal>true</taxIncludedInTotal>

        <taxAmount>55</taxAmount>

        <taxRate>0.0059</taxRate>

        <taxTypeIdentifier>00</taxTypeIdentifier>

        <cardAcceptorTaxId>011234567</cardAcceptorTaxId>

      </detailTax>

      <lineItemData>

        <itemSequenceNumber>1</itemSequenceNumber>

        <itemDescription>chair</itemDescription>

        <productCode>CH123</productCode>

        <quantity>1</quantity>

        <unitOfMeasure>EACH</unitOfMeasure>

        <taxAmount>125</taxAmount>

        <lineItemTotal>9380</lineItemTotal>

        <lineItemTotalWithTax>9505</lineItemTotalWithTax>

        <itemDiscountAmount>0</itemDiscountAmount>

        <commodityCode>300</commodityCode>

        <unitCost>93.80</unitCost>

        <detailTax>

          <taxIncludedInTotal>true</taxIncludedInTotal>

          <taxAmount>55</taxAmount>

          <taxRate>0.0059</taxRate>

          <taxTypeIdentifier>03</taxTypeIdentifier>

          <cardAcceptorTaxId>011234567</cardAcceptorTaxId>

        </detailTax>

      </lineItemData>

      <lineItemData>

        <itemSequenceNumber>2</itemSequenceNumber>

        <itemDescription>table</itemDescription>

        <productCode>TB123</productCode>

        <quantity>1</quantity>

        <unitOfMeasure>EACH</unitOfMeasure>

        <lineItemTotal>30000</lineItemTotal>

        <itemDiscountAmount>0</itemDiscountAmount>

        <commodityCode>300</commodityCode>

        <unitCost>300.00</unitCost>

      </lineItemData>

    </enhancedData>

  </capture>

</cnpOnlineRequest>

Example:  Online Capture Request - Partial Capture

A partial Capture has the partial attribute set to true and must include an <amount> child element. The example below also shows the <partialCapture> element/children used for marketplace/multi-party transactions.

<cnpOnlineRequest version="12.38" xmlns="http://www.vantivcnp.com/schema" merchantId="100">

  <authentication>

    <user>User Name</user>

    <password>password</password>

  </authentication>

  <capture id="2" reportGroup="ABC Division" customerId="038945" partial="true">

    <cnpTxnId>13254123434</cnpTxnId>

    <amount>100</amount>

    <enhancedData>

    <customerReference>PO12345</customerReference>

    <salesTax>125</salesTax>

    <taxExempt>false</taxExempt>

    <discountAmount>0</discountAmount>

    <shippingAmount>495</shippingAmount>

    <dutyAmount>0</dutyAmount>

    <shipFromPostalCode>01851</shipFromPostalCode>

    <destinationPostalCode>01851</destinationPostalCode>

    <destinationCountryCode>USA</destinationCountryCode>

    <invoiceReferenceNumber>123456</invoiceReferenceNumber>

    <orderDate>2011-08-14</orderDate>

    <detailTax>

      <taxIncludedInTotal>true</taxIncludedInTotal>

      <taxAmount>55</taxAmount>

      <taxRate>0.0059</taxRate>

      <taxTypeIdentifier>00</taxTypeIdentifier>

      <cardAcceptorTaxId>011234567</cardAcceptorTaxId>

    </detailTax>

    <lineItemData>

      <itemSequenceNumber>1</itemSequenceNumber>

      <itemDescription>chair</itemDescription>

      <productCode>CH123</productCode>

      <quantity>1</quantity>

      <unitOfMeasure>EACH</unitOfMeasure>

      <taxAmount>125</taxAmount>

      <lineItemTotal>9380</lineItemTotal>

      <lineItemTotalWithTax>9505</lineItemTotalWithTax>

      <itemDiscountAmount>0</itemDiscountAmount>

      <commodityCode>300</commodityCode>

      <unitCost>93.80</unitCost>

      <detailTax>

        <taxIncludedInTotal>true</taxIncludedInTotal>

        <taxAmount>55</taxAmount>

        <taxRate>0.0059</taxRate>

        <taxTypeIdentifier>03</taxTypeIdentifier>

        <cardAcceptorTaxId>011234567</cardAcceptorTaxId>

      </detailTax>

      </lineItemData>

      <lineItemData>

        <itemSequenceNumber>2</itemSequenceNumber>

        <itemDescription>table</itemDescription>

        <productCode>TB123</productCode>

        <quantity>1</quantity>

        <unitOfMeasure>EACH</unitOfMeasure>

        <lineItemTotal>30000</lineItemTotal>

        <itemDiscountAmount>0</itemDiscountAmount>

        <commodityCode>300</commodityCode>

        <unitCost>300.00</unitCost>

      </lineItemData>

    </enhancedData>

<partialCapture>

<partialCaptureSequenceNumber>2</partialCaptureSequenceNumber>

<partialCaptureTotalCount>5</partialCaptureTotalCount>

</partialCapture>

  </capture>

</cnpOnlineRequest>