Payeezy (formerly GGE4) Legacy Gateway Guide

close

Services and Compatibility

Payment Gateway Company Name:
Payeezy (formerly GGE4) Legacy
Services that work with Spreedly:
  • Payeezy (formerly GGE4) Legacy
Supported operations:
Purchase, Authorize, Capture, Refund, Void, Verify
Supported payment types:
Credit Card, Apple Pay
3D Secure 1 Supported
No
3D Secure 2 Supported
No
Regions:
North America
API endpoint URL:
https://api.globalgatewaye4.firstdata.com/transaction/v11

Authentication and Security

Specific names for credentials:
Gateway ID, Terminal Password

Onboarding Merchants in:

Additional Notes

Important Note: This is the legacy version of the Payeezy (Formerly Global Gateway E4) SOAP API gateway version-locked to v11, and Spreedly no longer fully supports new users of this version. The current, fully supported version of the Payeezy (Formerly Global Gateway E4) SOAP API gateway can be found here. And for First Data’s new Payeezy REST API gateway please review the documentation here.

Endpoint: https://api.globalgatewaye4.firstdata.com/transaction/v11

Adding a First Data gateway

To add a Payeezy (formerly GGE4) Legacy gateway:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>first_data_e4</gateway_type>
        <gateway_id>AD9098-04</gateway_id>
        <terminal_password>a421vd3113do</terminal_password>
      </gateway>'

<gateway>
  <token>YdnqgGNnR4gcIFbmVWI7C2cZzxc</token>
  <gateway_type>first_data_e4</gateway_type>
  <name>Payeezy (formerly GGE4)</name>
  <description nil="true"/>
  <gateway_id>AD9098-04</gateway_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">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_store type="boolean">false</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>gateway_id</name>
      <value>AD9098-04</value>
    </credential>
  </credentials>
  <gateway_specific_fields>
    <gateway_specific_field>customer_ref</gateway_specific_field>
    <gateway_specific_field>tax1_amount</gateway_specific_field>
    <gateway_specific_field>tax1_number</gateway_specific_field>
    <gateway_specific_field>ecommerce_flag</gateway_specific_field>
    <gateway_specific_field>level_3</gateway_specific_field>
  </gateway_specific_fields>
  <payment_methods>
    <payment_method>credit_card</payment_method>
    <payment_method>apple_pay</payment_method>
  </payment_methods>
  <state>retained</state>
  <redacted type="boolean">false</redacted>
  <created_at type="dateTime">2018-06-19T17:08:11Z</created_at>
  <updated_at type="dateTime">2018-06-19T17:08:11Z</updated_at>
</gateway>


env = Spreedly::Environment.new('C7cRfNJGODKh4Iu5Ox3PToKjniY', '4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ', base_url: 'https://core.spreedly.com')
env.add_gateway(:first_data_e4, gateway_id: "AD9098-04",
                terminal_password: "a421vd3113do")


#<Spreedly::Gateway:0x007fe332b713e0
@token="2qjlFKc2DH7dc4JuSvTfMmURtkO",
@created_at="2017-07-27T17:48:48Z",
@updated_at="2017-07-27T17:48:48Z",
@gateway_type="first_data_e4",
@state="retained",
@name="Payeezy (formerly GGE4)",
@credentials={"gateway_id"=>"AD9098-04"}>

Gateway specific fields

When interacting with a Payeezy (formerly GGE4) Legacy gateway to run transactions, there are some gateway specific fields you can specify. The level_3 field is different from the others in that you’ll need to use a CDATA element to specify it.


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>
          <first_data_e4>
            <customer_ref>44</customer_ref>
            <tax1_amount>50</tax1_amount>
            <tax1_number>A443</tax1_number>
            <ecommerce_flag>MOTO</ecommerce_flag>
            <level_3><![CDATA[<ShipFromZip>033993</ShipFromZip><DutyAmount>3.25</DutyAmount>]]></level_3>
          </first_data_e4>
        </gateway_specific_fields>
      </transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2017-07-27T17:48:48Z</created_at>
  <updated_at type="dateTime">2017-07-27T17:48:48Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>ARKE8wivF6DruWJcsVOehWvnpNk</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>
    <first_data_e4>
      <customer_ref>44</customer_ref>
      <tax1_amount>50</tax1_amount>
      <tax1_number>A443</tax1_number>
      <ecommerce_flag>MOTO</ecommerce_flag>
      <level_3>&lt;ShipFromZip&gt;033993&lt;/ShipFromZip&gt;&lt;DutyAmount&gt;3.25&lt;/DutyAmount&gt;</level_3>
    </first_data_e4>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>57</gateway_transaction_id>
  <gateway_latency_ms type="integer">20</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-07-27T17:48:48Z</created_at>
    <updated_at type="dateTime">2017-07-27T17:48:48Z</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-07-27T17:48:46Z</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>


env = Spreedly::Environment.new('C7cRfNJGODKh4Iu5Ox3PToKjniY', '4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ', base_url: 'https://core.spreedly.com')
env.purchase_on_gateway("LlkjmEk0xNkcWrNixXa1fvNoTP4", "56wyNnSmuA6CWYP7w0MiYCVIbW6", 4432,
  gateway_specific_fields: {
    first_data_e4: {
      customer_ref: "44",
      ecommerce_flag: "MOTO",
      level_3: "Some XML Properly escaped",
    }
  }
)


#<Spreedly::Purchase:0x007fe333b3f3f8
@token="Dm3q1CfqpXZPKbmtHN9XjGseJam",
@created_at="2017-07-27T17:48:49Z",
@updated_at="2017-07-27T17:48:49Z",
@state="succeeded",
@message="Succeeded!",
@succeeded="true",
@order_id="",
@ip="",
@description="",
@gateway_token="T11bJAANtTWnxl36GYjKWvbNK0g",
@gateway_transaction_id="67",
@email="",
@merchant_name_descriptor="",
@merchant_location_descriptor="",
@on_test_gateway="true",
@currency_code="USD",
@amount="4432",
@response,=
#<Spreedly::Response:0x007fe333b2d0e0
@success="true",
@pending="false",
@cancelled="false",
@fraud_review="",
@created_at="2017-07-27T17:48:49Z",
@updated_at="2017-07-27T17:48:49Z",
@message="Successful purchase",
@avs_code="",
@avs_message="",
@cvv_code="",
@cvv_message="",
@error_code="",
@error_detail="">,
@shipping_address,=
#<Spreedly::ShippingAddress:0x007fe333b1f648
@name="Newfirst Newlast",
@address1="",
@address2="",
@city="",
@state="",
@zip="",
@country="",
@phone_number="">,
@gateway_specific_fields={:first_data_e4=>{:customer_ref=>"44", :ecommerce_flag=>"MOTO", :level_3=>"Some XML Properly escaped"}},
@payment_method,=
#<Spreedly::CreditCard:0x007fe333b17b50
@token="1rpKvP8zOUhj4Y9EDrIoIYQzzD5",
@created_at="2017-06-26T17:04:38Z",
@updated_at="2017-07-27T17:48:48Z",
@email="joey@example.com",
@storage_state="retained",
@data="<my_payment_method_identifier>448</my_payment_method_identifier>\n      <extra_stuff>\n        <some_other_things>Can be anything really</some_other_things>\n      </extra_stuff>",
@first_name="Newfirst",
@last_name="Newlast",
@full_name="Newfirst Newlast",
@month="3",
@year="2032",
@number="XXXX-XXXX-XXXX-1111",
@last_four_digits="1111",
@first_six_digits="411111",
@card_type="visa",
@verification_value="",
@address1="",
@address2="",
@city="",
@state="",
@zip="",
@country="",
@phone_number="",
@company="",
@fingerprint="e3cef43464fc832f6e04f187df25af497994",
@eligible_for_card_updater="",
@errors=[]>>

Gateway specific response fields

A response from Payeezy (formerly GGE4) Legacy gateway may contain an authorization_num field which you can find in the gateway_specific_response_fields. For example, a transaction could have something like this:

<transaction>
  <token>LgpTNGjsWQs9DwdxcbreUVz0R8p</token>
  <transaction_type>Purchase</transaction_type>
  <gateway_specific_response_fields>
     <first_data_e4>
       <authorization_num>abc123</authorization_num>
     </first_data_e4>
  </gateway_specific_response_fields>
</transaction>

If you’d like 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.