Sale Request

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

When you submit the CVV2/CVC2/CID in a registerTokenRequest, the platform encrypts and stores the value on a temporary basis for later use in a tokenized Auth/Sale transaction submitted without the value. To use the stored value when submitting an Auth/Sale transaction, set the cardValidationNum value to 000.

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

  orderIdOrder Id</orderId>

  amountAuthorization Amount</amount>

  <secondaryAmount>Secondary Amount</secondaryAmount>

  <orderSource>Order Entry Source</orderSource>

  <customerInfo>

<sellerInfo>

  <billToAddress>

  <shipToAddress>

<retailerAddress>

<additionalCOFData>

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

  <cardholderAuthentication>

  <customBilling>

  <taxType>payment or fee</taxType>

  <enhancedData>

  <processingInstructions>

  <pos>

  <payPalOrderComplete>Send true in the final Sale</payPalOrderComplete>

  <allowPartialAuth>

  <healthcareIIAS>

  <lodgingInfo>

  <filtering>

  <merchantData>

  <recyclingRequest> (for Recycling Engine merchants)

  <fraudFilterOverride>

  <recurringRequest > (for Recurring Engine merchants)

  <debtRepayment>true or false</debtRepayment>

  <advancedFraudChecks>

  <wallet>

  <processingType>processingType Enum</processingType>

  <originalNetworkTransactionId>Network Txn Id Value</originalNetworkTransactionId>

  <originalTransactionAmount>Amount from Orig Txn</originalTransactionAmount>

  <pinlessDebitRequest>

  <skipRealtimeAU>

  <merchantCategoryCode>MCC Value</merchantCategoryCode>

  <businessIndicator>consumerBillPayment</businessIndicator>

  <passengerTransportData>

  <foreignRetailerIndicator>F</foreignRetailerIndicator>

<accountFundingTransactionData>

<fraudCheckAction>

<typeOfDigitalCurrency>Type value</typeOfDigitalCurrency>

<conversionAffiliateId>Conversion Affiliate Id value</conversionAffiliateId>

</sale>

Example:  Batch Sale Request

<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" numSales="1" saleAmount="12522" merchantId="100">

    <sale id="AX54321678" reportGroup="RG27">

      <orderId>12z58743y1</orderId>

      <amount>12522</amount>

      <orderSource>ecommerce</orderSource>

      <billToAddress>

        <name>John Doe</name>

        <addressLine1>123 4th street</addressLine1>

        <addressLine2>Apt. 20</addressLine2>

        <addressLine3>second floor</addressLine3>

        <city>San Jose</city>

        <state>CA</state>

        <zip>95032</zip>

        <country>USA</country>

        <email>jdoe@isp.com</email>

        <phone>408-555-1212</phone>

      </billToAddress>

      <card>

        <type>MC</type>

        <number>5186005800001012</number>

        <expDate>1110</expDate>

      </card>

    </sale>

  </batchRequest>

</cnpRequest>

Example:  Online Sale Request

The example below includes an <orderSource> value of 3dsAuthenticated and includes the <cardholderAuthentication> information. Use this <orderSource> value only if you are a 3DS merchant and authenticated the cardholder. Also, the values for the <authenticationValue> and <authenticationTransactionId> elements in the example below have been truncated.

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

  <authentication>

    <user>User Name</user>

    <password>password</password>

  </authentication>

  <sale id="1" reportGroup="ABC Division" customerId="038945">

    <orderId>5234234</orderId>

    <amount>40000</amount>

    <orderSource>3dsAuthenticated</orderSource>

      <billToAddress>

        <name>John Smith</name>

        <addressLine1>100 Main St</addressLine1>

        <addressLine2>100 Main St</addressLine2>

        <addressLine3>100 Main St</addressLine3>

        <city>Boston</city>

        <state>MA</state>

        <zip>12345</zip>

        <country>US</country>

        <email>jsmith@someaddress.com</email>

        <phone>555-123-4567</phone>

      </billToAddress>

      <card>

        <type>VI</type>

        <number>4005550000081019</number>

        <expDate>1210</expDate>

        <cardValidationNum>555</cardValidationNum>

      </card>

      <cardholderAuthentication>

        <authenticationValue>BwABBJQ1AgJDUCAAAAAAA=</authenticationValue>

        <authenticationTransactionId>gMV75TAgk=</authenticationTransactionId>

      </cardholderAuthentication>

      <customBilling>

        <phone>8888888888</phone>

        <descriptor>bdi*Vantiv Test</descriptor>

      </customBilling>

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

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

  </sale>

</cnpOnlineRequest>