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, General Credit
- Supported payment types:
- Credit Card
- Spreedly 3DS2 Global Supported
- Yes
- Gateway Specific 3DS2 Supported
- No
- Populate MIT GSF Support
- No
- Regions:
- Europe, Latin America, North America
- API endpoint URL:
-
https://api.shift4.com/
Authentication and Security
- Specific names for credentials:
- Secret Key
Onboarding Merchants in:
-
Andorra
-
Belgium
-
Bulgaria
-
Switzerland
-
Cyprus
-
Czechia
-
Germany
-
Denmark
-
Estonia
-
Spain
-
Finland
-
Faroe Islands
-
France
-
Gibraltar
-
Greenland
-
Greece
-
South Georgia and the South Sandwich Islands
-
Guatemala
-
Croatia
-
Hungary
-
Ireland
-
Iceland
-
Italy
-
Liechtenstein
-
Liberia
-
Lithuania
-
Luxembourg
-
Latvia
-
Monaco
-
Malta
-
Mauritius
-
Maldives
-
Malawi
-
Netherlands
-
Norway
-
Poland
-
Romania
-
Sweden
-
Slovenia
Don’t see your preferred region? Contact Us
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_v2</gateway_type>
<secret_key>Your secret key</secret_key>
</gateway>'
<gateway>
<token>UwOP9l4vDewRfCoVueGYI7LUcU</token>
<gateway_type>shift4_v2</gateway_type>
<name>Shift4 V2</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">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_offsite_synchronous_purchase type="boolean">false</supports_offsite_synchronous_purchase>
<supports_offsite_synchronous_authorize type="boolean">false</supports_offsite_synchronous_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">true</supports_3dsecure_2_mpi_purchase>
<supports_3dsecure_2_mpi_authorize type="boolean">true</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_inquire_by_gateway_transaction_id type="boolean">false</supports_inquire_by_gateway_transaction_id>
<supports_inquire_by_order_id type="boolean">false</supports_inquire_by_order_id>
<supports_transaction_retry type="boolean">false</supports_transaction_retry>
<supports_stored_stored_credentials type="boolean">false</supports_stored_stored_credentials>
<supports_refund type="boolean">true</supports_refund>
<supports_stored_credentials type="boolean">true</supports_stored_credentials>
</characteristics>
<credentials>
</credentials>
<gateway_settings>
</gateway_settings>
<gateway_specific_fields>
<gateway_specific_field>customer_id</gateway_specific_field>
<gateway_specific_field>ip</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">2023-08-30T21:02:33Z</created_at>
<updated_at type="dateTime">2023-08-30T21:02:33Z</updated_at>
</gateway>
env = Spreedly::Environment.new('C7cRfNJGODKh4Iu5Ox3PToKjniY', '4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ', base_url: 'https://core.spreedly.com')
env.add_gateway(:shift4_v2, secret_key: "Your secret key")
#<Spreedly::Gateway:0x00007fc11d8b4148
@token="Mri2pqZu0JcCLCA0RNVrzEanjBx",
@created_at="2023-08-30T21:02:33Z",
@updated_at="2023-08-30T21:02:33Z",
@gateway_type="shift4_v2",
@state="retained",
@name="Shift4 V2",
@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
, Purchase
, or Verify
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
When interacting with a Shift4 gateway to run transactions, there are many gateway specific fields you can specify when making a call:
customer_id
: Optional - an ID that identifies the customer in the gateway
curl https://core.spreedly.com/v1/gateways/LlkjmEk0xNkcWrNixXa1fvNoTP4/purchase.xml \
-u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
-H 'Content-Type: application/xml' \
-d '<transaction>
<billing_address>
<zip>31331</zip>
<state>NJ</state>
<phone_number>919.331.3313</phone_number>
<name>Francisca Torphy</name>
<country>US</country>
<city>Wanaque</city>
<address2>Apartment 4</address2>
<address1>33 Lane Road</address1>
</billing_address>
<email>johndoe@gmail.com</email>
<credit_card>
<first_name>Joe</first_name>
<last_name>Smith</last_name>
<number>4111111111111111</number>
<verification_value>123</verification_value>
<month>12</month>
<year>2035</year>
</credit_card>
<amount>100</amount>
<currency_code>USD</currency_code>
<gateway_specific_fields>
<shift4_v2>
<customer_id>cust_20fonSzUtRSgqHyoCEoua2Yy</customer_id>
<ip>255.255.255.255</ip>
</shift4_v2>
</gateway_specific_fields>
</transaction>'
<transaction>
<on_test_gateway type="boolean">true</on_test_gateway>
<created_at type="dateTime">2023-08-30T21:34:50Z</created_at>
<updated_at type="dateTime">2023-08-30T21:34:54Z</updated_at>
<succeeded type="boolean">true</succeeded>
<state>succeeded</state>
<token>Zny9ZzEudtxXfxUdtOy3MYxbpz9</token>
<transaction_type>Purchase</transaction_type>
<order_id nil="true"/>
<ip nil="true"/>
<description nil="true"/>
<email>johndoe@gmail.com</email>
<merchant_name_descriptor nil="true"/>
<merchant_location_descriptor nil="true"/>
<merchant_profile_key nil="true"/>
<gateway_specific_fields>
<shift4_v2>
<customer_id>cust_20fonSzUtRSgqHyoCEoua2Yy</customer_id>
<ip>255.255.255.255</ip>
</shift4_v2>
</gateway_specific_fields>
<gateway_specific_response_fields>
<shift4_v2>
</shift4_v2>
</gateway_specific_response_fields>
<gateway_transaction_id>char_Pn9cigwZn3uzqr3dbLWLaPRs</gateway_transaction_id>
<sub_merchant_key nil="true"/>
<gateway_latency_ms type="integer">952</gateway_latency_ms>
<warning nil="true"/>
<application_id nil="true"/>
<amount type="integer">100</amount>
<local_amount type="integer">100</local_amount>
<currency_code>USD</currency_code>
<retain_on_success type="boolean">false</retain_on_success>
<payment_method_added type="boolean">true</payment_method_added>
<smart_routed type="boolean">false</smart_routed>
<stored_credential_initiator nil="true"/>
<stored_credential_reason_type nil="true"/>
<stored_credential_gateway_override nil="true"/>
<populate_mit_fields type="boolean">false</populate_mit_fields>
<message key="messages.transaction_succeeded">Succeeded!</message>
<gateway_token>HIos65zXmTvS7ezx4W5y3piMSRX</gateway_token>
<gateway_type>shift4_v2</gateway_type>
<billing_address>
<name>Francisca Torphy</name>
<address1>33 Lane Road</address1>
<address2>Apartment 4</address2>
<city>Wanaque</city>
<state>NJ</state>
<zip>31331</zip>
<country>US</country>
<phone_number>919.331.3313</phone_number>
</billing_address>
<shipping_address>
<name>Joe Smith</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>Transaction approved</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-08-30T21:34:52Z</created_at>
<updated_at type="dateTime">2023-08-30T21:34:54Z</updated_at>
</response>
<api_urls>
</api_urls>
<payment_method>
<token>D5Qos8kWimItZqw3bieXwwNS21T</token>
<created_at type="dateTime">2023-08-30T21:34:50Z</created_at>
<updated_at type="dateTime">2023-08-30T21:34:50Z</updated_at>
<email nil="true"/>
<data nil="true"/>
<storage_state>cached</storage_state>
<test type="boolean">true</test>
<metadata nil="true"/>
<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>Joe</first_name>
<last_name>Smith</last_name>
<month type="integer">12</month>
<year type="integer">2035</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>Joe Smith</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>41111111</issuer_identification_number>
<click_to_pay type="boolean">false</click_to_pay>
<managed nil="true"/>
<payment_method_type>credit_card</payment_method_type>
<errors>
</errors>
<verification_value>XXX</verification_value>
<number>XXXX-XXXX-XXXX-1111</number>
<fingerprint nil="true"/>
</payment_method>
<attempt_3dsecure type="boolean">false</attempt_3dsecure>
</transaction>