Payeezy Gateway Guide

Payeezy fact sheet

Additional notes

Additional notes
Using Visa and Mastercard cards `retained` with Spreedly falls under Stored Credentials regulations. Using the `store` method requires an additional gateway specific field required by Payeezy. If you plan on using bank accounts as a payment method for Payeezy transactions, you must send a couple additional gateway specific fields required by Payeezy but not Spreedly. Specifically `client_id_type`, `client_id_number`, and `client_email`. For First Data’s older Payeezy gateway, also called Global Gateway e4 (GGE4) please go to the documentation /here. This is the current Payeezy release (REST API). This gateway also has connectivity to First Data’s International Payment Gateway (IPG) Payeezy UK for Europe, India, Brazil, and Australia. Endpoint: https://api.payeezy.com/v1

Using Visa and Mastercard cards retained with Spreedly falls under Stored Credentials regulations.

Using the store method requires an additional gateway specific field required by Payeezy.

If you plan on using bank accounts as a payment method for Payeezy transactions, you must send a couple additional gateway specific fields required by Payeezy but not Spreedly. Specifically client_id_type, client_id_number, and client_email.

For First Data’s older Payeezy gateway, also called Global Gateway e4 (GGE4) please go to the documentation /here. This is the current Payeezy release (REST API). This gateway also has connectivity to First Data’s International Payment Gateway (IPG) Payeezy UK for Europe, India, Brazil, and Australia.

Endpoint: https://api.payeezy.com/v1

Adding a Payeezy gateway

To add a Payeezy gateway:

curl https://core.spreedly.com/v1/gateways.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>payeezy</gateway_type>
        <api_key>Your api key</api_key>
        <api_secret>Your api secret</api_secret>
        <api_token>Your api token</api_token>
      </gateway>'

<gateway>
  <token>VIFlMCPS9gzXrCUJdtdLYE2R3FS</token>
  <gateway_type>payeezy</gateway_type>
  <name>Payeezy</name>
  <description nil="true"/>
  <api_key>Your api key</api_key>
  <api_token>Your api token</api_token>
  <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_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_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>
  </characteristics>
  <credentials>
    <credential>
      <name>api_key</name>
      <value>Your api key</value>
    </credential>
    <credential>
      <name>api_token</name>
      <value>Your api token</value>
    </credential>
  </credentials>
  <gateway_specific_fields>
    <gateway_specific_field>soft_descriptors</gateway_specific_field>
    <gateway_specific_field>customer_id_type</gateway_specific_field>
    <gateway_specific_field>customer_id_number</gateway_specific_field>
    <gateway_specific_field>client_email</gateway_specific_field>
    <gateway_specific_field>ta_token</gateway_specific_field>
    <gateway_specific_field>reversal_id</gateway_specific_field>
    <gateway_specific_field>cardbrand_original_transaction_id</gateway_specific_field>
    <gateway_specific_field>sequence</gateway_specific_field>
    <gateway_specific_field>is_scheduled</gateway_specific_field>
    <gateway_specific_field>initiator</gateway_specific_field>
    <gateway_specific_field>auth_type_override</gateway_specific_field>
  </gateway_specific_fields>
  <payment_methods>
    <payment_method>credit_card</payment_method>
    <payment_method>bank_account</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-03-06T20:32:36Z</created_at>
  <updated_at type="dateTime">2023-03-06T20:32:36Z</updated_at>
</gateway>

To learn more about creating and managing gateways in our Marketplace, review the Gateway user guide. For gateways not included in the Marketplace, review the steps below.

Create a gateway

Visit your Connections area to review all gateways and add new ones. When creating your gateways, select the gateway name and authentication mode (if prompted) before completing required fields. Select ☑️Sandbox to create a gateway in Sandbox mode, for processing test card data and transactions in your Spreedly environment.

Supply your api_key, api_secret and api_token to create a Payeezy gateway.

Third-party 3DS2 auth data

Spreedly will automatically handle the field mapping for sending third-party 3DS2 authentication data to Payeezy. For more information about how to use this feature, see the 3DS2 Third-party authentication guide. Spreedly fields map to the relevant Payeezy fields as described in the following table. Please see Payeezy’s third-party 3DS documentation for detailed descriptions of each of these fields and when to use them.

Spreedly field	Payeezy field
`three_ds_version`	`program_protocol`
`ecommerce_indicator`	`eci_indicator`
`authentication_value`	`cavv`
`ds_transaction_id`	`directory_server_transaction_id`
`acs_transaction_id`	`xid`

Gateway specific fields

When interacting with a Payeezy gateway to run transactions, there are some gateway specific fields you can specify.

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>
          <payeezy>
            <reversal_id>the-reversal-id</reversal_id>
            <customer_id_type>The customer id type</customer_id_type>
            <customer_id_number>The customer id number</customer_id_number>
            <client_email>The client email</client_email>
            <soft_descriptors>
              <dba_name>Caddyshack</dba_name>
              <street>1234 Any Street</street>
              <city>Durham</city>
              <region>North Carolina</region>
              <mid>mid_1234</mid>
              <mcc>mcc_5678</mcc>
              <postal_code>27701</postal_code>
              <country_code>US</country_code>
              <merchant_contact_info>8885551212</merchant_contact_info>
            </soft_descriptors>
            <level2>
              <customer_ref>Customer 123</customer_ref>
            </level2>
            <ta_token>ta_token</ta_token>
            <cardbrand_original_transaction_id>abc123</cardbrand_original_transaction_id>
            <sequence>FIRST</sequence>
            <is_scheduled>true</is_scheduled>
            <initiator>MERCHANT</initiator>
            <auth_type_override>A</auth_type_override>
            <customer_ref>Customer123</customer_ref>
            <reference_3>12345</reference_3>
          </payeezy>
        </gateway_specific_fields>
      </transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2023-11-14T22:38:19Z</created_at>
  <updated_at type="dateTime">2023-11-14T22:38:19Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>KP00pll2JawH15Xxpfwy2pYFzBu</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>
    <payeezy>
      <reversal_id>the-reversal-id</reversal_id>
      <customer_id_type>The customer id type</customer_id_type>
      <customer_id_number>The customer id number</customer_id_number>
      <client_email>The client email</client_email>
      <soft_descriptors>
        <dba_name>Caddyshack</dba_name>
        <street>1234 Any Street</street>
        <city>Durham</city>
        <region>North Carolina</region>
        <mid>mid_1234</mid>
        <mcc>mcc_5678</mcc>
        <postal_code>27701</postal_code>
        <country_code>US</country_code>
        <merchant_contact_info>8885551212</merchant_contact_info>
      </soft_descriptors>
      <level2>
        <customer_ref>Customer 123</customer_ref>
      </level2>
      <ta_token>ta_token</ta_token>
      <cardbrand_original_transaction_id>abc123</cardbrand_original_transaction_id>
      <sequence>FIRST</sequence>
      <is_scheduled>true</is_scheduled>
      <initiator>MERCHANT</initiator>
      <auth_type_override>A</auth_type_override>
      <customer_ref>Customer123</customer_ref>
      <reference_3>12345</reference_3>
    </payeezy>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>68</gateway_transaction_id>
  <sub_merchant_key nil="true"/>
  <gateway_latency_ms type="integer">1</gateway_latency_ms>
  <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>
  <stored_credential_initiator nil="true"/>
  <stored_credential_reason_type nil="true"/>
  <stored_credential_alternate_gateway nil="true"/>
  <populate_mit_fields type="boolean">false</populate_mit_fields>
  <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">2023-11-14T22:38:19Z</created_at>
    <updated_at type="dateTime">2023-11-14T22:38:19Z</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">2023-11-03T16:29:47Z</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>
    <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"/>
    <click_to_pay type="boolean">false</click_to_pay>
    <managed nil="true"/>
    <payment_method_type>credit_card</payment_method_type>
    <stored_credential_usage>
      <test>
        <original_network_transaction_id>37be5367d6dbe4a88c9d</original_network_transaction_id>
        <network_transaction_id>37be5367d6dbe4a88c9d</network_transaction_id>
      </test>
    </stored_credential_usage>
    <errors>
    </errors>
    <verification_value></verification_value>
    <number>XXXX-XXXX-XXXX-1111</number>
    <bin_metadata>
      <message>BIN Metadata is available only to Advanced Vault enrolled customers and payment methods. Reach out to your account representative for more details.</message>
    </bin_metadata>
    <fingerprint>e3cef43464fc832f6e04f187df25af497994</fingerprint>
  </payment_method>
  <attempt_3dsecure type="boolean">false</attempt_3dsecure>
</transaction>

Stored credentials regulations

Complying with Stored Credentials regulations requires flagging when card information that is stored with an intermediary is used for a transaction. This applies to Visa and Mastercard cards retained with Spreedly.

You may meet this requirement using either Spreedly’s stored credential framework or some of the following gateway specific fields: cardbrand_original_transaction_id, sequence, is_scheduled, initiator and auth_type_override. These fields, if provided, will take priority over the data provided by the standardized stored credential framework. Please see the Payeezy docs for more information.

Timeout reversals

The reversal_id field can be added to any authorize or purchase transaction. In the event of a timeout, the same reversal_id can then be specified via void to reverse the transaction.

Soft descriptors

You can specify soft_descriptors to pass in dynamic soft descriptor data for a transaction.

ACH specified fields

Transactions using a bank account payment method require some additional data. Specifically, customer_id_type, customer_id_number, and client_email.

If client_email is not provided, and there is an email already associated with the bank account payment method, that email will be used.

See the Payeezy ACH docs for more information.

Specified fields for store

US Merchants will receive a Transarmor multi-use token when the store method is used to tokenize a credit card.

A gateway specific field is required for this:

ta_token

Please refer to Payeezy documentation for instructions on obtaining these values.

Gateway specific response fields

After a successful store transaction, Payeezy will return card_type, card_name, card_exp_date and a token_value. All of these values will need to be used if you intend to use the token outside of the Spreedly API. When available, Payeezy will return the correlation_id and transaction_tag; these may be useful for credit transactions, which generate “RETURN” as their transaction_id.

After a transaction, Payeezy will return gateway_resp_code and gateway_message. These fields will be present if the transaction succeeds or fails, but can be helpful in identifying the reason a transaction may have failed.

After some 3DS transactions, Payeezy may return an ecommerce_flag value.

You can find this information in gateway_specific_response_fields. For example, a transaction could have the following:

<transaction>
  <token>LgpTNGjsWQs9DwdxcbreUVz0R8p</token>
  <transaction_type>Store</transaction_type>
  <gateway_specific_response_fields>
    <Payeezy>
      <card_type>Visa</card_type>
      <card_name>Tony Stark</card_name>
      <card_exp_date>12/20</card_exp_date>
      <token_value>ABC1234</token_value>
      <correlation_id>123.456789012</correlation_id>
      <transaction_tag>1234567890</transaction_tag>
      <gateway_resp_code>00</gateway_resp_code>
      <gateway_message>Transaction Normal</gateway_message>
      <ecommerce_flag>6<ecommerce_flag>
    </Payeezy>
  </gateway_specific_response_fields>
</transaction>

See Payeezy tokenization docs for more information.

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.