Payeezy (formerly GGE4) Gateway Guide

close

Services and Compatibility

Payment Gateway Company Name:
Payeezy (formerly GGE4)
Services that work with Spreedly:
  • Payeezy (formerly GGE4)
Supported operations:
Purchase, Authorize, Capture, Refund, Void, Verify
Supported payment types:
Credit Card, Apple Pay
Regions:
North America

Authentication and Security

Specific names for credentials:
Gateway ID, Terminal Password

Onboarding Merchants in:

Additional Notes

Please confirm with First Data that your account is configured to work with the gateway previously called GGE4. For First Data’s new Payeezy gateway please review the documentation here.

Adding

To add a Payeezy (formerly GGE4) gateway:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'Ll6fAtoVSTyVMlJEmtpoJV8S:RKOCG5D8D3fZxDSg504D0IxU2XD4Io5VXmyzdCtTivHFTTSy' \
  -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>8knvDLV8qPBKymUBrEryIJ5wKnt</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">2016-08-11T17:14:40Z</created_at>
  <updated_at type="dateTime">2016-08-11T17:14:40Z</updated_at>
</gateway>


env = Spreedly::Environment.new('Ll6fAtoVSTyMlJEm', 'RKcG5D8D3fZxDSg504U2XD4Io5VXz')
env.add_gateway(:first_data_e4, gateway_id: "AD9098-04",
                terminal_password: "a421vd3113do")


#<Spreedly::Gateway:0x007fbfe98d2808
 @created_at="2016-08-11T17:14:41Z",
 @credentials={"gateway_id"=>"AD9098-04"},
 @gateway_type="first_data_e4",
 @name="Payeezy (formerly GGE4)",
 @state="retained",
 @token="Nsq8dc4QUu9xFFCYQjaG4DdwetX",
 @updated_at="2016-08-11T17:14:41Z">

Optional Gateway Specific Fields

When interacting with a Payeezy (formerly GGE4) 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 'Ll6fAtoVSTyVMlJEmtpoJV8S:RKOCG5D8D3fZxDSg504D0IxU2XD4Io5VXmyzdCtTivHFTTSy' \
  -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">2016-08-11T17:14:41Z</created_at>
  <updated_at type="dateTime">2016-08-11T17:14:41Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>972PEyWTapNfdfKYhW4NitkPhBr</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>59</gateway_transaction_id>
  <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>8dvNMSuDr3kTlMIQxbkIaE5KNlX</gateway_token>
  <shipping_address>
    <name>Robert Lemke</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">2016-08-11T17:14:41Z</created_at>
    <updated_at type="dateTime">2016-08-11T17:14:41Z</updated_at>
  </response>
  <api_urls>
  </api_urls>
  <payment_method>
    <token>UAwoPyWJhwZiYe2ZY1ri6ENAjLG</token>
    <created_at type="dateTime">2016-08-11T17:09:30Z</created_at>
    <updated_at type="dateTime">2016-08-11T17:14:37Z</updated_at>
    <email nil="true"/>
    <data nil="true"/>
    <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>Robert</first_name>
    <last_name>Lemke</last_name>
    <month type="integer">4</month>
    <year type="integer">2020</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>Robert Lemke</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>b0a45066121c1f1a49b3a6ffc26caf2995db</fingerprint>
  </payment_method>
</transaction>


env = Spreedly::Environment.new('Ll6fAtoVSTyMlJEm', 'RKcG5D8D3fZxDSg504U2XD4Io5VXz')
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:0x007f8033cc1900
 @amount="4432",
 @created_at="2016-08-11T17:14:42Z",
 @currency_code="USD",
 @description="",
 @email="",
 @gateway_specific_fields=
  {:first_data_e4=>
    {:customer_ref=>"44",
     :ecommerce_flag=>"MOTO",
     :level_3=>"Some XML Properly escaped"}},
 @gateway_token="8dvNMSuDr3kTlMIQxbkIaE5KNlX",
 @gateway_transaction_id="46",
 @ip="",
 @merchant_location_descriptor="",
 @merchant_name_descriptor="",
 @message="Succeeded!",
 @on_test_gateway="true",
 @order_id="",
 @payment_method=
  #<Spreedly::CreditCard:0x007f8033228390
   @address1="",
   @address2="",
   @card_type="visa",
   @city="",
   @company="",
   @country="",
   @created_at="2016-08-11T17:09:30Z",
   @data="",
   @eligible_for_card_updater="",
   @email="",
   @errors=[],
   @fingerprint="b0a45066121c1f1a49b3a6ffc26caf2995db",
   @first_name="Robert",
   @first_six_digits="411111",
   @full_name="Robert Lemke",
   @last_four_digits="1111",
   @last_name="Lemke",
   @month="4",
   @number="XXXX-XXXX-XXXX-1111",
   @phone_number="",
   @state="",
   @storage_state="retained",
   @token="UAwoPyWJhwZiYe2ZY1ri6ENAjLG",
   @updated_at="2016-08-11T17:14:41Z",
   @verification_value="",
   @year="2020",
   @zip="">,
 @response=
  #<Spreedly::Response:0x007f80331e5400
   @avs_code="",
   @avs_message="",
   @cancelled="false",
   @created_at="2016-08-11T17:14:42Z",
   @cvv_code="",
   @cvv_message="",
   @error_code="",
   @error_detail="",
   @fraud_review="",
   @message="Successful purchase",
   @pending="false",
   @success="true",
   @updated_at="2016-08-11T17:14:42Z">,
 @shipping_address=
  #<Spreedly::ShippingAddress:0x007f803322bc20
   @address1="",
   @address2="",
   @city="",
   @country="",
   @name="Robert Lemke",
   @phone_number="",
   @state="",
   @zip="">,
 @state="succeeded",
 @succeeded="true",
 @token="Vd3M4x4BZx1x8IU0mQpp8PHMYrx",
 @updated_at="2016-08-11T17:14:42Z">

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.