Force Capture Request

You must specify the Force Capture request as follows. The structure of the request is identical for either an Online or a Batch submission.

<forceCapture id="Id" reportGroup="iQ Report Group" customerId="Customer Id">

  <orderId>Order Id</orderId>

  <amount>Force Capture Amount</amount>

  <secondaryAmount>Secondary Amount</secondaryAmount>

  <orderSource>Order Entry Source</orderSource>

  <billToAddress>

  [<card> | <token> | <paypage> | <mpos>]

  <customBilling>

  <taxType>payment or fee</taxType>

  <enhancedData>

  <lodgingInfo>

  <processingInstructions>

  <pos>

  <merchantData>

  <debtRepayment>true or false</debtRepayment>

  <processingType>processingType Enum</processingType>

  <businessIndicator>consumerBillPayment</businessIndicator>

  <passengerTransportData>

  <foreignRetailerIndicator>F</foreignRetailerIndicator>

<accountFundingTransactionData>

</forceCapture>

Example: Batch Force Capture Request

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

  <authentication>

    <user>userName</user>

    <password>password</password>

  </authentication>

  <batchRequest id="01234567" numForceCaptures="1" forceCaptureAmount="10000" merchantId="100">

    <forceCapture id="AX54321678" reportGroup="RG27" customerId="038945">

      <orderId>orderId</orderId>

      <amount>10000</amount>

      <orderSource>ecommerce</orderSource>

      <card>

        <type>VI</type>

        <number>4005550000081019</number>

        <expDate>0910</expDate>

      </card>

      <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>2016-09-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>

      </enhancedData>

      <foreignRetailerIndicator>F</foreignRetailerIndicator>

    </forceCapture>

  </batchRequest>

</cnpRequest>

Example: Online Force Capture Request

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

  <authentication>

    <user>userName</user>

    <password>password</password>

  </authentication>

  <forceCapture id="AX54321678" reportGroup="RG27" customerId="038945">

    <orderId>orderId</orderId>

    <amount>10000</amount>

    <orderSource>ecommerce</orderSource>

    <card>

      <type>VI</type>

      <number>4005550000081019</number>

      <expDate>0907</expDate>

    </card>

    <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>2016-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>

      </lineItemData>

    </enhancedData>

  </forceCapture>

</cnpOnlineRequest>