Payeezy (formerly GGE4) Gateway Guide

Payeezy (formerly GGE4) fact sheet

Additional notes
Please confirm with First Data that your account is configured to work with the gateway previously called GGE4. This is the Payeezy (Formerly GGE4) SOAP API gateway version 28. Endpoint: https://api.globalgatewaye4.firstdata.com/transaction/v28

Adding a Payeezy gateway

To add a Payeezy (formerly GGE4) gateway:

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

<gateway>
  <token>SOK9kSOMzG0oTMhp6vC6rRvdBmi</token>
  <gateway_type>first_data_e4_v27</gateway_type>
  <name>Payeezy (formerly GGE4) v27</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">true</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_field>wallet_provider_id</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-07-31T19:19:48Z</created_at>
  <updated_at type="dateTime">2018-07-31T19:19:48Z</updated_at>
</gateway>

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. Also please note that wallet_provider_id is required for Apple Pay transactions.

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>
            <wallet_provider_id>4</wallet_provider_id>
          </first_data_e4>
        </gateway_specific_fields>
      </transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2018-07-31T19:19:47Z</created_at>
  <updated_at type="dateTime">2018-07-31T19:19:47Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>Hq8ht55QoyPWZV20rdGV3t6eQBn</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>
      <wallet_provider_id>4</wallet_provider_id>
    </first_data_e4>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>51</gateway_transaction_id>
  <gateway_latency_ms type="integer">31</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>
  <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></error_code>
    <error_detail nil="true"/>
    <cancelled type="boolean">false</cancelled>
    <fraud_review nil="true"/>
    <created_at type="dateTime">2018-07-31T19:19:47Z</created_at>
    <updated_at type="dateTime">2018-07-31T19:19:47Z</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">2018-07-28T01:49:30Z</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>
    <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>

Gateway specific response fields

A response from Payeezy (formerly GGE4) 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>

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.