Fat Zebra Gateway Guide

close

Services and Compatibility

Payment Gateway Company Name:
Fat Zebra Pty. Ltd.
Services that work with Spreedly:
  • Fat Zebra
Supported operations:
Purchase, Authorize, Capture, Refund, Store
Unsupported operations:
Void
Regions:
Asia Pacific

Authentication and Security

Specific names for credentials:
Username, Api Token

Onboarding Merchants in:

Adding

To add a Fat Zebra gateway:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'Ll6fAtoVSTyVMlJEmtpoJV8S:RKOCG5D8D3fZxDSg504D0IxU2XD4Io5VXmyzdCtTivHFTTSy' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>fat_zebra</gateway_type>
        <username>Your Username</username>
        <api_token>Your API Token</api_token>
      </gateway>'

<gateway>
  <token>W53fOyqiuTnlKQaEVyCFz0NtkP1</token>
  <gateway_type>fat_zebra</gateway_type>
  <name>Fat Zebra</name>
  <description nil="true"/>
  <username>Your Username</username>
  <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">false</supports_void>
    <supports_verify type="boolean">false</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>username</name>
      <value>Your Username</value>
    </credential>
  </credentials>
  <gateway_specific_fields>
    <gateway_specific_field>merchant_name_descriptor</gateway_specific_field>
    <gateway_specific_field>merchant_location_descriptor</gateway_specific_field>
    <gateway_specific_field>cavv</gateway_specific_field>
    <gateway_specific_field>xid</gateway_specific_field>
    <gateway_specific_field>sli</gateway_specific_field>
  </gateway_specific_fields>
  <payment_methods>
    <payment_method>credit_card</payment_method>
    <payment_method>third_party_token</payment_method>
  </payment_methods>
  <state>retained</state>
  <redacted type="boolean">false</redacted>
  <created_at type="dateTime">2016-10-07T19:00:46Z</created_at>
  <updated_at type="dateTime">2016-10-07T19:00:46Z</updated_at>
</gateway>


env = Spreedly::Environment.new('Ll6fAtoVSTyMlJEm', 'RKcG5D8D3fZxDSg504U2XD4Io5VXz')
env.add_gateway(:fat_zebra, username: "Your username", api_token: "Your API token")


#<Spreedly::Gateway:0x007faf89386888
 @created_at="2016-08-11T17:14:40Z",
 @credentials={"username"=>"Your username"},
 @gateway_type="fat_zebra",
 @name="Fat Zebra",
 @state="retained",
 @token="12aqi75uZjnShxHU0PZRpNZayUH",
 @updated_at="2016-08-11T17:14:40Z">

Gateway specific fields

When interacting with a Fat Zebra gateway to run transactions, there are some gateway specific fields you can specify when making a purchase or authorize call, including merchant_name_descriptor and merchant_location_descriptor. 3DS information can also be sent with the cavv, xid, and sli fields, but be advised that they must all be present for the transaction to succeed. These can be added like this:


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>
          <fat_zebra>
            <merchant_name_descriptor>Merchant Name</merchant_name_descriptor>
            <merchant_location_descriptor>Merchant Location</merchant_location_descriptor>
            <cavv>CAVV</cavv>
            <xid>XID</xid>
            <sli>SLI</sli>
          </fat_zebra>
        </gateway_specific_fields>
      </transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2016-10-07T19:03:42Z</created_at>
  <updated_at type="dateTime">2016-10-07T19:03:42Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>DmPcqgmSoU1FcqvC8o23wqbOxy0</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>
    <fat_zebra>
      <merchant_name_descriptor>Merchant Name</merchant_name_descriptor>
      <merchant_location_descriptor>Merchant Location</merchant_location_descriptor>
      <cavv>CAVV</cavv>
      <xid>XID</xid>
      <sli>SLI</sli>
    </fat_zebra>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>50</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>G5paAyK3ZyONfHxh5qJcBViFgZx</gateway_token>
  <shipping_address>
    <name>Khalil Schowalter</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-10-07T19:03:42Z</created_at>
    <updated_at type="dateTime">2016-10-07T19:03:42Z</updated_at>
  </response>
  <api_urls>
  </api_urls>
  <payment_method>
    <token>YHGChcqYyg5WWJj764bFTUCJaAv</token>
    <created_at type="dateTime">2016-09-19T17:14:01Z</created_at>
    <updated_at type="dateTime">2016-10-07T19:00:47Z</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>Khalil</first_name>
    <last_name>Schowalter</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>Khalil Schowalter</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>

Gateway specific response fields

A response from a Fat Zebra gateway may contain a settlement_date.

You can find this information in 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>
     <fat_zebra>
       <settlement_date>2015-06-03</settlement_date>
     </fat_zebra>
  </gateway_specific_response_fields>
</transaction>