Vantiv Express Gateway Guide

Vantiv Express fact sheet

Adding a Vantiv Express gateway

To add a Vantiv Express gateway:

curl https://core.spreedly.com/v1/gateways.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>element</gateway_type>
        <account_id>Your account id</account_id>
        <account_token>Your account token</account_token>
        <application_id>Your application id</application_id>
        <acceptor_id>Your acceptor_id</acceptor_id>
        <application_name>Your application name</application_name>
        <application_version>Your application version</application_version>
      </gateway>'

<gateway>
  <token>CLGWmsAQGiHYULvL687DqfLhJnD</token>
  <gateway_type>element</gateway_type>
  <name>Vantiv Express (formerly Element)</name>
  <description nil="true"/>
  <merchant_profile_key nil="true"/>
  <sub_merchant_key nil="true"/>
  <account_id>Your account id</account_id>
  <application_id>Your application id</application_id>
  <acceptor_id>Your acceptor_id</acceptor_id>
  <application_name>Your application name</application_name>
  <application_version>Your application version</application_version>
  <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">true</supports_general_credit>
    <supports_void type="boolean">true</supports_void>
    <supports_adjust type="boolean">false</supports_adjust>
    <supports_verify type="boolean">true</supports_verify>
    <supports_reference_purchase type="boolean">false</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_3dsecure_2_mpi_purchase type="boolean">false</supports_3dsecure_2_mpi_purchase>
    <supports_3dsecure_2_mpi_authorize type="boolean">false</supports_3dsecure_2_mpi_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_network_tokenization type="boolean">false</supports_network_tokenization>
    <supports_populate_mit_fields type="boolean">false</supports_populate_mit_fields>
  </characteristics>
  <credentials>
    <credential>
      <name>account_id</name>
      <value>Your account id</value>
    </credential>
    <credential>
      <name>application_id</name>
      <value>Your application id</value>
    </credential>
    <credential>
      <name>acceptor_id</name>
      <value>Your acceptor_id</value>
    </credential>
    <credential>
      <name>application_name</name>
      <value>Your application name</value>
    </credential>
    <credential>
      <name>application_version</name>
      <value>Your application version</value>
    </credential>
  </credentials>
  <gateway_settings>
  </gateway_settings>
  <gateway_specific_fields>
    <gateway_specific_field>card_present_code</gateway_specific_field>
    <gateway_specific_field>payment_type</gateway_specific_field>
    <gateway_specific_field>submission_type</gateway_specific_field>
    <gateway_specific_field>duplicate_check_disable_flag</gateway_specific_field>
    <gateway_specific_field>merchant_descriptor</gateway_specific_field>
    <gateway_specific_field>market_code</gateway_specific_field>
    <gateway_specific_field>ticket_number</gateway_specific_field>
    <gateway_specific_field>merchant_supplied_transaction_id</gateway_specific_field>
    <gateway_specific_field>terminal_id</gateway_specific_field>
  </gateway_specific_fields>
  <payment_methods>
    <payment_method>credit_card</payment_method>
    <payment_method>bank_account</payment_method>
    <payment_method>third_party_token</payment_method>
    <payment_method>apple_pay</payment_method>
    <payment_method>google_pay</payment_method>
  </payment_methods>
  <state>retained</state>
  <redacted type="boolean">false</redacted>
  <sandbox type="boolean">false</sandbox>
  <mode>default</mode>
  <created_at type="dateTime">2022-12-29T16:13:35Z</created_at>
  <updated_at type="dateTime">2022-12-29T16:13:35Z</updated_at>
</gateway>

To learn more about creating and managing gateways in our Marketplace, review the Gateway user guide. For gateways not included in the Marketplace, review the steps below.

Create a gateway

Visit your Connections area to review all gateways and add new ones. When creating your gateways, select the gateway name and authentication mode (if prompted) before completing required fields. Select ☑️Sandbox to create a gateway in Sandbox mode, for processing test card data and transactions in your Spreedly environment.

Enter your account_id, account_token, acceptor_id, application_name, application_id and application_version into their respective fields to create a new Vantiv Express gateway.

Gateway specific fields

Spreedly supports the following gateway specific fields when transacting with a Vantiv Express (formerly Element) gateway:

card_present_code
payment_type
submission_type
duplicate_check_disable_flag
duplicate_override_flag
terminal_id
merchant_descriptor
market_code
ticket_number
merchant_supplied_transaction_id
terminal_type
card_holder_present_code
card_input_code
cvv_presence_code
terminal_capability_code
terminal_environment_code
partial_approved_flag
lodging

The ticket_number field is required when performing a general_credit transaction.

The lodging field accepts an object which is required when performing hotel/lodging transactions. If you wish to initiate a hotel/lodging transaction, the market_code field will need to indicate the correct transaction type. For more information please refer to the Express documentation.

For example, the lodging field can look like the structure below:

<gateway_specific_fields>
    <element>
      <lodging>
        <agreement_number>12345</agreement_number>
        <check_in_date>YYYYMMDD</check_in_date>
        <check_out_date>YYYYMMDD</check_out_date>
        <room_amount>1000</room_amount>
        <room_tax>0</room_tax>
        <no_show_indicator>0</no_show_indicator>
        <duration>5</duration>
        <customer_name>First Last</customer_name>
        <client_code>Default</client_code>
        <extra_charges_detail>01</extra_charges_detail>
        <extra_charges_amounts>Default</extra_charges_amounts>
        <prestigious_property_code>DollarLimit500</prestigious_property_code>
        <special_program_code>Sale</special_program_code>
        <charge_type>Restaurant</charge_type>
      </lodging>
    </element>
  </gateway_specific_fields>

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>
          <element>
            <card_present_code>3</card_present_code>
            <payment_type>2</payment_type>
            <submission_type>2</submission_type>
            <duplicate_check_disable_flag>true</duplicate_check_disable_flag>
            <duplicate_override_flag>true</duplicate_override_flag>
            <terminal_id>02</terminal_id>
            <merchant_descriptor>Flowerpot Florists</merchant_descriptor>
            <market_code>3</market_code>
            <ticket_number>1</ticket_number>
            <merchant_supplied_transaction_id>Your transaction identifier</merchant_supplied_transaction_id>
            <terminal_type>ECommerce</terminal_type>
            <card_holder_present_code>ECommerce</card_holder_present_code>
            <card_input_code>ManualKeyed</card_input_code>
            <cvv_presence_code>NotPresent</cvv_presence_code>
            <terminal_capability_code>KeyEntered</terminal_capability_code>
            <terminal_environment_code>ECommerce</terminal_environment_code>
            <partial_approved_flag>Your partial approved flag</partial_approved_flag>
            <lodging>
              <agreement_number>12345</agreement_number>
              <check_in_date>YYYYMMDD</check_in_date>
              <check_out_date>YYYYMMDD</check_out_date>
              <room_amount>1000</room_amount>
              <room_tax>0</room_tax>
              <no_show_indicator>0</no_show_indicator>
              <duration>5</duration>
              <customer_name>First Last</customer_name>
              <client_code>Default</client_code>
              <extra_charges_detail>01</extra_charges_detail>
              <extra_charges_amounts>Default</extra_charges_amounts>
              <prestigious_property_code>DollarLimit500</prestigious_property_code>
              <special_program_code>Sale</special_program_code>
              <charge_type>Restaurant</charge_type>
            </lodging>
          </element>
        </gateway_specific_fields>
      </transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2023-10-27T16:48:54Z</created_at>
  <updated_at type="dateTime">2023-10-27T16:48:54Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>Td1UixjDX62SI9OS3m8l58uxqa5</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"/>
  <merchant_profile_key nil="true"/>
  <gateway_specific_fields>
    <element>
      <card_present_code>3</card_present_code>
      <payment_type>2</payment_type>
      <submission_type>2</submission_type>
      <duplicate_check_disable_flag>true</duplicate_check_disable_flag>
      <duplicate_override_flag>true</duplicate_override_flag>
      <terminal_id>02</terminal_id>
      <merchant_descriptor>Flowerpot Florists</merchant_descriptor>
      <market_code>3</market_code>
      <ticket_number>1</ticket_number>
      <merchant_supplied_transaction_id>Your transaction identifier</merchant_supplied_transaction_id>
      <terminal_type>ECommerce</terminal_type>
      <card_holder_present_code>ECommerce</card_holder_present_code>
      <card_input_code>ManualKeyed</card_input_code>
      <cvv_presence_code>NotPresent</cvv_presence_code>
      <terminal_capability_code>KeyEntered</terminal_capability_code>
      <terminal_environment_code>ECommerce</terminal_environment_code>
      <partial_approved_flag>Your partial approved flag</partial_approved_flag>
      <lodging>
        <agreement_number>12345</agreement_number>
        <check_in_date>YYYYMMDD</check_in_date>
        <check_out_date>YYYYMMDD</check_out_date>
        <room_amount>1000</room_amount>
        <room_tax>0</room_tax>
        <no_show_indicator>0</no_show_indicator>
        <duration>5</duration>
        <customer_name>First Last</customer_name>
        <client_code>Default</client_code>
        <extra_charges_detail>01</extra_charges_detail>
        <extra_charges_amounts>Default</extra_charges_amounts>
        <prestigious_property_code>DollarLimit500</prestigious_property_code>
        <special_program_code>Sale</special_program_code>
        <charge_type>Restaurant</charge_type>
      </lodging>
    </element>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>45</gateway_transaction_id>
  <sub_merchant_key nil="true"/>
  <gateway_latency_ms type="integer">1</gateway_latency_ms>
  <warning nil="true"/>
  <application_id nil="true"/>
  <amount type="integer">100</amount>
  <local_amount nil="true"/>
  <currency_code>USD</currency_code>
  <retain_on_success type="boolean">false</retain_on_success>
  <payment_method_added type="boolean">false</payment_method_added>
  <smart_routed type="boolean">false</smart_routed>
  <stored_credential_initiator nil="true"/>
  <stored_credential_reason_type nil="true"/>
  <stored_credential_alternate_gateway nil="true"/>
  <populate_mit_fields type="boolean">false</populate_mit_fields>
  <message key="messages.transaction_succeeded">Succeeded!</message>
  <gateway_token>T11bJAANtTWnxl36GYjKWvbNK0g</gateway_token>
  <gateway_type>test</gateway_type>
  <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 nil="true"/>
    <error_detail nil="true"/>
    <cancelled type="boolean">false</cancelled>
    <fraud_review nil="true"/>
    <created_at type="dateTime">2023-10-27T16:48:54Z</created_at>
    <updated_at type="dateTime">2023-10-27T16:48:54Z</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">2023-10-26T21:03:29Z</updated_at>
    <email>[email protected]</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>
    <metadata>
      <key>string value</key>
    </metadata>
    <callback_url nil="true"/>
    <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 type="boolean">true</eligible_for_card_updater>
    <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"/>
    <issuer_identification_number nil="true"/>
    <click_to_pay type="boolean">false</click_to_pay>
    <managed nil="true"/>
    <payment_method_type>credit_card</payment_method_type>
    <stored_credential_usage>
      <test>
        <original_network_transaction_id>37be5367d6dbe4a88c9d</original_network_transaction_id>
        <network_transaction_id>37be5367d6dbe4a88c9d</network_transaction_id>
      </test>
    </stored_credential_usage>
    <errors>
    </errors>
    <verification_value></verification_value>
    <number>XXXX-XXXX-XXXX-1111</number>
    <bin_metadata>
      <message>BIN Metadata is available only to Advanced Vault enrolled customers and payment methods. Reach out to your account representative for more details.</message>
    </bin_metadata>
    <fingerprint>e3cef43464fc832f6e04f187df25af497994</fingerprint>
  </payment_method>
  <attempt_3dsecure type="boolean">false</attempt_3dsecure>
</transaction>

To request any gateway_specific_fields or gateway_specific_response_fields, please contact Support with your request and the gateway documentation for the fields of interest.