Vantiv eCommerce Gateway Guide

close

Services and Compatibility

Payment Gateway Company Name:
Vantiv, Inc.
Services that work with Spreedly:
  • Vantiv eCommerce
Supported operations:
Purchase, Authorize, Capture, Refund, Void, Verify, Store
Supported payment types:
Credit Card, Apple Pay, Android Pay
Regions:
North America

Authentication and Security

Specific names for credentials:
Merchant ID, User, Password

Onboarding Merchants in:

Additional Notes

Please note Vantiv eCommerce gateway flags “duplicate transactions” based on order_id. To avoid having legitimate transactions unfulfilled at the gateway, please ensure order_id is unique for supported transactions.

Adding a Vantiv eCommerce gateway

To add a Vantiv eCommerce gateway:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>litle</gateway_type>
        <user>user</user>
        <password>password</password>
        <merchant_id>your merchant id</merchant_id>
      </gateway>'

<gateway>
  <token>Kgx3kqrB3uKaxjfSlfRhr3qNtso</token>
  <gateway_type>litle</gateway_type>
  <name>Vantiv eCommerce</name>
  <description nil="true"/>
  <user>user</user>
  <merchant_id>your merchant id</merchant_id>
  <characteristics>
    <supports_purchase type="boolean">true</supports_purchase>
    <supports_authorize type="boolean">true</supports_authorize>
    <supports_capture type="boolean">true</supports_capture>
    <supports_credit type="boolean">true</supports_credit>
    <supports_general_credit type="boolean">false</supports_general_credit>
    <supports_void type="boolean">true</supports_void>
    <supports_verify type="boolean">true</supports_verify>
    <supports_reference_purchase type="boolean">true</supports_reference_purchase>
    <supports_purchase_via_preauthorization type="boolean">false</supports_purchase_via_preauthorization>
    <supports_offsite_purchase type="boolean">false</supports_offsite_purchase>
    <supports_offsite_authorize type="boolean">false</supports_offsite_authorize>
    <supports_3dsecure_purchase type="boolean">false</supports_3dsecure_purchase>
    <supports_3dsecure_authorize type="boolean">false</supports_3dsecure_authorize>
    <supports_store type="boolean">true</supports_store>
    <supports_remove type="boolean">false</supports_remove>
    <supports_fraud_review type="boolean">false</supports_fraud_review>
    <supports_disburse type="boolean">false</supports_disburse>
  </characteristics>
  <credentials>
    <credential>
      <name>user</name>
      <value>user</value>
    </credential>
    <credential>
      <name>merchant_id</name>
      <value>your merchant id</value>
    </credential>
  </credentials>
  <gateway_specific_fields>
    <gateway_specific_field>descriptor_name</gateway_specific_field>
    <gateway_specific_field>descriptor_phone</gateway_specific_field>
    <gateway_specific_field>order_source</gateway_specific_field>
    <gateway_specific_field>report_group</gateway_specific_field>
    <gateway_specific_field>customer_id</gateway_specific_field>
    <gateway_specific_field>debt_repayment</gateway_specific_field>
    <gateway_specific_field>cavv</gateway_specific_field>
    <gateway_specific_field>xid</gateway_specific_field>
  </gateway_specific_fields>
  <payment_methods>
    <payment_method>credit_card</payment_method>
    <payment_method>third_party_token</payment_method>
    <payment_method>apple_pay</payment_method>
    <payment_method>android_pay</payment_method>
  </payment_methods>
  <state>retained</state>
  <redacted type="boolean">false</redacted>
  <created_at type="dateTime">2017-08-10T18:09:34Z</created_at>
  <updated_at type="dateTime">2017-08-10T18:09:34Z</updated_at>
</gateway>


env = Spreedly::Environment.new('C7cRfNJGODKh4Iu5Ox3PToKjniY', '4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ', base_url: 'https://core.spreedly.com')
env.add_gateway(:litle, user: "Your user", password: "Your password",
                merchant_id: "Your merchant_id")


#<Spreedly::Gateway:0x007fe332a690b0
@token="LzELConViEgRO0fDM09EZanHwRT",
@created_at="2017-07-27T17:49:14Z",
@updated_at="2017-07-27T17:49:14Z",
@gateway_type="litle",
@state="retained",
@name="Vantiv eCommerce",
@credentials={"user"=>"Your user", "merchant_id"=>"Your merchant_id"}>

Optional Gateway Specific Fields

When interacting with a Vantiv eCommerce gateway to run transactions, there are some gateway specific fields you can specify.

Dynamic descriptors, descriptor_name and descriptor_phone, can be used by the merchant to define what will appear on the customer’s credit card statement for the purchase.

You can use report_group to separate your transactions into different categories.

order_source, customer_id, debt_repayment may also be sent.

3DSecure data can be passed using cavv and xid fields. Please note that in order for 3DSecure transactions to succeed with Vantiv, you must also send the order_source field with a value of either 3dsAuthenticated or 3dsAttempted.

You can pass these gateway specific fields like so:


curl https://core.spreedly.com/v1/gateways/LlkjmEk0xNkcWrNixXa1fvNoTP4/purchase.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<transaction>
        <payment_method_token>56wyNnSmuA6CWYP7w0MiYCVIbW6</payment_method_token>
        <amount>100</amount>
        <currency_code>USD</currency_code>
        <gateway_specific_fields>
          <litle>
            <descriptor_name>companyName</descriptor_name>
            <descriptor_phone>1331131131</descriptor_phone>
            <customer_id>88</customer_id>
            <debt_repayment>true</debt_repayment>
            <report_group>Domestic Business</report_group>
            <order_source>recurring</order_source>
            <cavv>CAVV</cavv>
            <xid>XID</xid>
          </litle>
        </gateway_specific_fields>
      </transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2017-08-10T17:45:02Z</created_at>
  <updated_at type="dateTime">2017-08-10T17:45:02Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>L7ElwnLYgBhKjSPqgACZgoc1AV3</token>
  <transaction_type>Purchase</transaction_type>
  <order_id nil="true"/>
  <ip nil="true"/>
  <description nil="true"/>
  <email nil="true"/>
  <merchant_name_descriptor nil="true"/>
  <merchant_location_descriptor nil="true"/>
  <gateway_specific_fields>
    <litle>
      <descriptor_name>companyName</descriptor_name>
      <descriptor_phone>1331131131</descriptor_phone>
      <customer_id>88</customer_id>
      <debt_repayment>true</debt_repayment>
      <report_group>Domestic Business</report_group>
      <order_source>recurring</order_source>
      <cavv>CAVV</cavv>
      <xid>XID</xid>
    </litle>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>68</gateway_transaction_id>
  <gateway_latency_ms type="integer">18</gateway_latency_ms>
  <amount type="integer">100</amount>
  <currency_code>USD</currency_code>
  <retain_on_success type="boolean">false</retain_on_success>
  <payment_method_added type="boolean">false</payment_method_added>
  <message key="messages.transaction_succeeded">Succeeded!</message>
  <gateway_token>T11bJAANtTWnxl36GYjKWvbNK0g</gateway_token>
  <shipping_address>
    <name>Newfirst Newlast</name>
    <address1 nil="true"/>
    <address2 nil="true"/>
    <city nil="true"/>
    <state nil="true"/>
    <zip nil="true"/>
    <country nil="true"/>
    <phone_number nil="true"/>
  </shipping_address>
  <response>
    <success type="boolean">true</success>
    <message>Successful purchase</message>
    <avs_code nil="true"/>
    <avs_message nil="true"/>
    <cvv_code nil="true"/>
    <cvv_message nil="true"/>
    <pending type="boolean">false</pending>
    <result_unknown type="boolean">false</result_unknown>
    <error_code></error_code>
    <error_detail nil="true"/>
    <cancelled type="boolean">false</cancelled>
    <fraud_review nil="true"/>
    <created_at type="dateTime">2017-08-10T17:45:02Z</created_at>
    <updated_at type="dateTime">2017-08-10T17:45:02Z</updated_at>
  </response>
  <api_urls>
  </api_urls>
  <payment_method>
    <token>1rpKvP8zOUhj4Y9EDrIoIYQzzD5</token>
    <created_at type="dateTime">2017-06-26T17:04:38Z</created_at>
    <updated_at type="dateTime">2017-08-01T19:41:13Z</updated_at>
    <email>joey@example.com</email>
    <data>
      <my_payment_method_identifier>448</my_payment_method_identifier>
      <extra_stuff>
        <some_other_things>Can be anything really</some_other_things>
      </extra_stuff>
    </data>
    <storage_state>retained</storage_state>
    <test type="boolean">true</test>
    <last_four_digits>1111</last_four_digits>
    <first_six_digits>411111</first_six_digits>
    <card_type>visa</card_type>
    <first_name>Newfirst</first_name>
    <last_name>Newlast</last_name>
    <month type="integer">3</month>
    <year type="integer">2032</year>
    <address1 nil="true"/>
    <address2 nil="true"/>
    <city nil="true"/>
    <state nil="true"/>
    <zip nil="true"/>
    <country nil="true"/>
    <phone_number nil="true"/>
    <company nil="true"/>
    <full_name>Newfirst Newlast</full_name>
    <eligible_for_card_updater nil="true"/>
    <shipping_address1 nil="true"/>
    <shipping_address2 nil="true"/>
    <shipping_city nil="true"/>
    <shipping_state nil="true"/>
    <shipping_zip nil="true"/>
    <shipping_country nil="true"/>
    <shipping_phone_number nil="true"/>
    <payment_method_type>credit_card</payment_method_type>
    <errors>
    </errors>
    <verification_value></verification_value>
    <number>XXXX-XXXX-XXXX-1111</number>
    <fingerprint>e3cef43464fc832f6e04f187df25af497994</fingerprint>
  </payment_method>
</transaction>

If you’d like to request any gateway_specific_fields or gateway_specific_response_fields, please email support@spreedly.com with your request and the gateway documentation for the fields of interest.