Shift4 Gateway Guide

close

Services and Compatibility

Payment Gateway Company Name:
Shift4
Services that work with Spreedly:
  • Shift4
Supported operations:
Purchase, Authorize, Capture, Refund, Void, Verify, Store
Supported payment types:
Credit Card
Spreedly 3DS2 Global Supported
No
Gateway Specific 3DS1 Supported
No
Gateway Specific 3DS2 Supported
No
Regions:
Europe, Latin America, North America
API endpoint URL:
https://utg.shift4api.net/api/rest/v1/

Authentication and Security

Specific names for credentials:
Auth Token, Client Guid

Onboarding Merchants in:

Additional Notes

When a new Shift4 gateway is created, Spreedly uses your client_guid and auth_token credentials to create and store an accessToken in accordance with Shift4 guidelines. Spreedly will automatically send your accessToken on any subsequent Shift4 transactions, and can be found in the transaction transcript.

Adding a Shift4 gateway

To add a Shift4 gateway:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>shift4</gateway_type>
        <client_guid>Your client guid</client_guid>
        <auth_token>Your auth token</auth_token>
      </gateway>'

<gateway>
  <token>HyQGoKPCxEhwm7Kx4S5VoITrW9F</token>
  <gateway_type>shift4</gateway_type>
  <name>Shift4</name>
  <description nil="true"/>
  <merchant_profile_key nil="true"/>
  <sub_merchant_key nil="true"/>
  <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_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_offsite_synchronous_purchase type="boolean">false</supports_offsite_synchronous_purchase>
    <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>
    <supports_refund type="boolean">true</supports_refund>
  </characteristics>
  <credentials>
  </credentials>
  <gateway_settings>
  </gateway_settings>
  <gateway_specific_fields>
    <gateway_specific_field>numeric_id</gateway_specific_field>
    <gateway_specific_field>notes</gateway_specific_field>
    <gateway_specific_field>tax</gateway_specific_field>
    <gateway_specific_field>customer_reference</gateway_specific_field>
    <gateway_specific_field>destination_postal_code</gateway_specific_field>
    <gateway_specific_field>product_descriptors</gateway_specific_field>
    <gateway_specific_field>interface_version</gateway_specific_field>
    <gateway_specific_field>interface_name</gateway_specific_field>
    <gateway_specific_field>company_name</gateway_specific_field>
    <gateway_specific_field>merchant_time_zone</gateway_specific_field>
    <gateway_specific_field>date_time</gateway_specific_field>
  </gateway_specific_fields>
  <payment_methods>
    <payment_method>credit_card</payment_method>
    <payment_method>third_party_token</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-07-28T11:09:46Z</created_at>
  <updated_at type="dateTime">2022-07-28T11:09:46Z</updated_at>
</gateway>


env = Spreedly::Environment.new('C7cRfNJGODKh4Iu5Ox3PToKjniY', '4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ', base_url: 'https://core.spreedly.com')
env.add_gateway(:shift4, client_guid: "Your client id", auth_token: "Your auth token")


#<Spreedly::Gateway:0x00007ff450a32c48
@token="XH2HvmcGdKRBAy0KrmdCwBb9bf5",
@created_at="2022-06-24T16:55:18Z",
@updated_at="2022-06-24T16:55:18Z",
@gateway_type="shift4",
@state="retained",
@name="Shift4",
@credentials={}>

Stored credentials

For Shift4 gateway, sending stored credential fields can be done using Spreedly’s first class support. Sending stored credential data is simple. For any Authorize or Purchase request, you need to include these fields which tell Spreedly a little bit more about the nature of the transaction:

  • stored_credential_initiator
  • stored_credential_reason_type

Learn more about how Spreedly enables seamless use of stored credentials by reviewing our Stored Credentials Guide.

Gateway specific fields

Spreedly supports the following gateway specific fields when transacting with a Shift4 gateway:

  • numeric_id
  • notes
  • tax
  • customer_reference
  • destination_postal_code
  • product_descriptors
  • company_name
  • interface_name
  • interface_version
  • merchant_time_zone
  • date_time

merchant_time_zone supports field values as per the rails documentation mapping of time zones. When no value is passed, this field defaults to Pacific Time (US & Canada) time zone.


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>
          <shift4>
            <numeric_id>1576</numeric_id>
            <notes>test notes</notes>
            <tax>2</tax>
            <customer_reference>D019D09309F2</customer_reference>
            <destination_postal_code>94719</destination_postal_code>
            <product_descriptors>['Hamburger', 'Fries', 'Soda', 'Cookie']</product_descriptors>
            <interface_version>2.1</interface_version>
            <interface_name>ForwardPOS</interface_name>
            <company_name>Spreedly</company_name>
            <merchant_time_zone>Arizona</merchant_time_zone>
            <date_time>2022-07-20T16:49:15.595+16:49</date_time>
          </shift4>
        </gateway_specific_fields>
      </transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2022-07-28T11:09:44Z</created_at>
  <updated_at type="dateTime">2022-07-28T11:09:44Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>1EjQmwZQqwhzsIhlSjLdoL9EyJ0</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>
    <shift4>
      <numeric_id>1576</numeric_id>
      <notes>test notes</notes>
      <tax>2</tax>
      <customer_reference>D019D09309F2</customer_reference>
      <destination_postal_code>94719</destination_postal_code>
      <product_descriptors>[Hamburger, Fries, Soda, Cookie]</product_descriptors>
      <interface_version>2.1</interface_version>
      <interface_name>ForwardPOS</interface_name>
      <company_name>Spreedly</company_name>
      <merchant_time_zone>Arizona</merchant_time_zone>
      <date_time>2022-07-20T16:49:15.595+16:49</date_time>
    </shift4>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>52</gateway_transaction_id>
  <sub_merchant_key nil="true"/>
  <gateway_latency_ms type="integer">0</gateway_latency_ms>
  <stored_credential_initiator nil="true"/>
  <stored_credential_reason_type nil="true"/>
  <populate_mit_fields type="boolean">false</populate_mit_fields>
  <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>
  <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">2022-07-28T11:09:44Z</created_at>
    <updated_at type="dateTime">2022-07-28T11:09:44Z</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">2022-07-21T16:47:12Z</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>
    <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"/>
    <payment_method_type>credit_card</payment_method_type>
    <errors>
    </errors>
    <verification_value></verification_value>
    <number>XXXX-XXXX-XXXX-1111</number>
    <fingerprint>e3cef43464fc832f6e04f187df25af497994</fingerprint>
    <stored_credential_usage>
      <test>
        <original_network_transaction_id>37be5367d6dbe4a88c9d</original_network_transaction_id>
        <network_transaction_id>37be5367d6dbe4a88c9d</network_transaction_id>
      </test>
    </stored_credential_usage>
  </payment_method>
  <attempt_3dsecure type="boolean">false</attempt_3dsecure>
</transaction>

Gateway specific response fields

Stored credential transactions should contain a network_transaction_id response field when a transaction succeeds. For example, a transaction could have something like this:

<transaction>
  <token>KuO7X6Vhx6XPof1Goq4sDqI8fMV</token>
  <transaction_type>purchase</transaction_type>
  <gateway_specific_response_fields>
     <shift4>
       <network_transaction_id>Z00000008492780</network_transaction_id>
       <invoice>4666309473</invoice>
     </shift4>
  </gateway_specific_response_fields>
</transaction>