Payeezy Gateway Guide

close

Services and Compatibility

Payment Gateway Company Name:
Payeezy
Services that work with Spreedly:
  • Payeezy
Supported operations:
Purchase, Authorize, Capture, Refund, Void, Verify
Supported payment types:
Credit Card, Bank Account
Regions:
North America

Authentication and Security

Specific names for credentials:
Api Key, Api Token, Api Secret

Onboarding Merchants in:

Adding a Payeezy gateway

To add a Payeezy gateway:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'Ll6fAtoVSTyVMlJEmtpoJV8S:RKOCG5D8D3fZxDSg504D0IxU2XD4Io5VXmyzdCtTivHFTTSy' \
  -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>JZnKAFgxWaPKU8C14oj7YwOO4t</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">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>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_fields>
  <payment_methods>
    <payment_method>credit_card</payment_method>
    <payment_method>bank_account</payment_method>
  </payment_methods>
  <state>retained</state>
  <redacted type="boolean">false</redacted>
  <created_at type="dateTime">2016-08-11T17:15:28Z</created_at>
  <updated_at type="dateTime">2016-08-11T17:15:28Z</updated_at>
</gateway>

Optional Gateway Specific Fields

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

You can specify soft_descriptors to pass in dynamic soft descriptor data for a transaction. Please refer Payeezy docs for relevant fields.


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>
          <payeezy>
            <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>
          </payeezy>
        </gateway_specific_fields>
      </transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2017-03-31T18:19:15Z</created_at>
  <updated_at type="dateTime">2017-03-31T18:19:15Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>UtmeKWqZnIcBoXa1KSUlKuoDaWp</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>
    <payeezy>
      <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>
    </payeezy>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>54</gateway_transaction_id>
  <gateway_latency_ms type="integer">0</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>LDAsrvRY2EDhtiGG950AAdAm5PJ</gateway_token>
  <shipping_address>
    <name>Elmo Mayert</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-03-31T18:19:15Z</created_at>
    <updated_at type="dateTime">2017-03-31T18:19:15Z</updated_at>
  </response>
  <api_urls>
  </api_urls>
  <payment_method>
    <token>X35rj217lxtpc8vK548jqkMqRlY</token>
    <created_at type="dateTime">2017-02-28T17:28:33Z</created_at>
    <updated_at type="dateTime">2017-03-23T20:16:14Z</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>Elmo</first_name>
    <last_name>Mayert</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>Elmo Mayert</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 nil="true"/>
  </payment_method>
</transaction>


env = Spreedly::Environment.new('Ll6fAtoVSTyMlJEm', 'RKcG5D8D3fZxDSg504U2XD4Io5VXz')
env.purchase_on_gateway("LlkjmEk0xNkcWrNixXa1fvNoTP4", "56wyNnSmuA6CWYP7w0MiYCVIbW6", 4432,
  gateway_specific_fields: {
    payeezy: {
      soft_descriptors: {
        dba_name: "Caddyshack",
        street: "1234 Any Street",
        city: "Durham",
        region: "North Carolina",
        mid: "mid_1234",
        mcc: "mcc_5678",
        postal_code: "27701",
        country_code: "US",
        merchant_contact_info: "8885551212"
      }
    }
  }
)


#<Spreedly::Purchase:0x007fd89c9d9208
 @amount="4432",
 @created_at="2017-03-31T18:19:17Z",
 @currency_code="USD",
 @description="",
 @email="",
 @gateway_specific_fields=
  {:payeezy=>
    {:soft_descriptors=>
      "\n        Caddyshack\n        1234 Any Street\n        Durham\n        North Carolina\n        mid_1234\n        mcc_5678\n        27701\n        US\n        8885551212\n      "}},
 @gateway_token="LDAsrvRY2EDhtiGG950AAdAm5PJ",
 @gateway_transaction_id="62",
 @ip="",
 @merchant_location_descriptor="",
 @merchant_name_descriptor="",
 @message="Succeeded!",
 @on_test_gateway="true",
 @order_id="",
 @payment_method=
  #<Spreedly::CreditCard:0x007fd89c2c54a8
   @address1="",
   @address2="",
   @card_type="visa",
   @city="",
   @company="",
   @country="",
   @created_at="2017-02-28T17:28:33Z",
   @data="",
   @eligible_for_card_updater="",
   @email="",
   @errors=[],
   @fingerprint="",
   @first_name="Elmo",
   @first_six_digits="411111",
   @full_name="Elmo Mayert",
   @last_four_digits="1111",
   @last_name="Mayert",
   @month="4",
   @number="XXXX-XXXX-XXXX-1111",
   @phone_number="",
   @state="",
   @storage_state="retained",
   @token="X35rj217lxtpc8vK548jqkMqRlY",
   @updated_at="2017-03-31T18:19:15Z",
   @verification_value="",
   @year="2020",
   @zip="">,
 @response=
  #<Spreedly::Response:0x007fd89c987188
   @avs_code="",
   @avs_message="",
   @cancelled="false",
   @created_at="2017-03-31T18:19:17Z",
   @cvv_code="",
   @cvv_message="",
   @error_code="",
   @error_detail="",
   @fraud_review="",
   @message="Successful purchase",
   @pending="false",
   @success="true",
   @updated_at="2017-03-31T18:19:17Z">,
 @shipping_address=
  #<Spreedly::ShippingAddress:0x007fd89c9575c8
   @address1="",
   @address2="",
   @city="",
   @country="",
   @name="Elmo Mayert",
   @phone_number="",
   @state="",
   @zip="">,
 @state="succeeded",
 @succeeded="true",
 @token="Yd93PlPhqCaIsysZM3u7EMq3Ua8",
 @updated_at="2017-03-31T18:19:17Z">