JetPay Gateway Guide

close

Services and Compatibility

Payment Gateway Company Name:
JetPay
Services that work with Spreedly:
  • JetPay
Supported operations:
Purchase, Authorize, Capture, Refund, Void, General Credit
Regions:
North America

Authentication and Security

Specific names for credentials:
Login, Region

Onboarding Merchants in:

Adding

To add a JetPay gateway:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'Ll6fAtoVSTyVMlJEmtpoJV8S:RKOCG5D8D3fZxDSg504D0IxU2XD4Io5VXmyzdCtTivHFTTSy' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>jetpay</gateway_type>
        <login>Your terminal ID</login>
      </gateway>'

<gateway>
  <token>F8EOc33jVeA8TeBl4ujm5is8niV</token>
  <gateway_type>jetpay</gateway_type>
  <name>JetPay</name>
  <description nil="true"/>
  <login>Your terminal ID</login>
  <region nil="true"/>
  <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">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">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>login</name>
      <value>Your terminal ID</value>
    </credential>
    <credential>
      <name>region</name>
      <value nil="true"/>
    </credential>
  </credentials>
  <gateway_specific_fields>
    <gateway_specific_field>ud_field_1</gateway_specific_field>
    <gateway_specific_field>ud_field_2</gateway_specific_field>
    <gateway_specific_field>ud_field_3</gateway_specific_field>
    <gateway_specific_field>origin</gateway_specific_field>
  </gateway_specific_fields>
  <payment_methods>
    <payment_method>credit_card</payment_method>
  </payment_methods>
  <state>retained</state>
  <redacted type="boolean">false</redacted>
  <created_at type="dateTime">2016-08-11T17:14:58Z</created_at>
  <updated_at type="dateTime">2016-08-11T17:14:58Z</updated_at>
</gateway>


env = Spreedly::Environment.new('Ll6fAtoVSTyMlJEm', 'RKcG5D8D3fZxDSg504U2XD4Io5VXz')
env.add_gateway(:jetpay, login: "Your Terminal ID")


#<Spreedly::Gateway:0x007ffe61c32c58
 @created_at="2016-08-11T17:14:58Z",
 @credentials={"login"=>"Your Terminal ID", "region"=>""},
 @gateway_type="jetpay",
 @name="JetPay",
 @state="retained",
 @token="DTw8UctPK03ckhE0IFztUiUlIzB",
 @updated_at="2016-08-11T17:14:58Z">

Specifying a region

You may specify a region like so:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'Ll6fAtoVSTyVMlJEmtpoJV8S:RKOCG5D8D3fZxDSg504D0IxU2XD4Io5VXmyzdCtTivHFTTSy' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>jetpay</gateway_type>
        <login>Your terminal ID</login>
        <region>CA</region>
      </gateway>'

<gateway>
  <token>6wgs2hhjFUHHvRn7KodWYWpLvEI</token>
  <gateway_type>jetpay</gateway_type>
  <name>JetPay</name>
  <description nil="true"/>
  <login>Your terminal ID</login>
  <region>CA</region>
  <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">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">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>login</name>
      <value>Your terminal ID</value>
    </credential>
    <credential>
      <name>region</name>
      <value>CA</value>
    </credential>
  </credentials>
  <gateway_specific_fields>
    <gateway_specific_field>ud_field_1</gateway_specific_field>
    <gateway_specific_field>ud_field_2</gateway_specific_field>
    <gateway_specific_field>ud_field_3</gateway_specific_field>
    <gateway_specific_field>origin</gateway_specific_field>
  </gateway_specific_fields>
  <payment_methods>
    <payment_method>credit_card</payment_method>
  </payment_methods>
  <state>retained</state>
  <redacted type="boolean">false</redacted>
  <created_at type="dateTime">2016-08-11T17:15:00Z</created_at>
  <updated_at type="dateTime">2016-08-11T17:15:00Z</updated_at>
</gateway>

Gateway specific response fields

A response from a JetPay gateway may contain an approval from the underlying processor.

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>
     <jetpay>
       <approval>TEST97</approval>
     </jetpay>
  </gateway_specific_response_fields>
</transaction>

Gateway specific request fields

When interacting with a JetPay gateway to run transactions, there are some gateway specific fields you can specify when making a purchase or authorize call:


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>
          <jetpay>
            <ud_field_1>3341</ud_field_1>
            <ud_field_2>data</ud_field_2>
            <ud_field_3>user_defined_field_information</ud_field_3>
            <origin>INTERNET</origin>
          </jetpay>
        </gateway_specific_fields>
      </transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2016-08-11T17:14:59Z</created_at>
  <updated_at type="dateTime">2016-08-11T17:14:59Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>MUslAoggvM51kiDoIbSPRQPecF9</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>
    <jetpay>
      <ud_field_1>3341</ud_field_1>
      <ud_field_2>data</ud_field_2>
      <ud_field_3>user_defined_field_information</ud_field_3>
      <origin>INTERNET</origin>
    </jetpay>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>44</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:59Z</created_at>
    <updated_at type="dateTime">2016-08-11T17:14:59Z</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:52Z</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: {
    jetpay: {
      ud_field_1: "user defined field 1",
      ud_field_2: 0,
      ud_field_3: "more information",
      origin: "INTERNET"
    }
  }
)


#<Spreedly::Purchase:0x007f9063b3d6e8
 @amount="4432",
 @created_at="2016-08-11T17:14:59Z",
 @currency_code="USD",
 @description="",
 @email="",
 @gateway_specific_fields=
  {:jetpay=>
    {:ud_field_1=>"user defined field 1",
     :ud_field_2=>"0",
     :ud_field_3=>"more information",
     :origin=>"INTERNET"}},
 @gateway_token="8dvNMSuDr3kTlMIQxbkIaE5KNlX",
 @gateway_transaction_id="65",
 @ip="",
 @merchant_location_descriptor="",
 @merchant_name_descriptor="",
 @message="Succeeded!",
 @on_test_gateway="true",
 @order_id="",
 @payment_method=
  #<Spreedly::CreditCard:0x007f9062bb8150
   @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:59Z",
   @verification_value="",
   @year="2020",
   @zip="">,
 @response=
  #<Spreedly::Response:0x007f9063b55220
   @avs_code="",
   @avs_message="",
   @cancelled="false",
   @created_at="2016-08-11T17:14:59Z",
   @cvv_code="",
   @cvv_message="",
   @error_code="",
   @error_detail="",
   @fraud_review="",
   @message="Successful purchase",
   @pending="false",
   @success="true",
   @updated_at="2016-08-11T17:14:59Z">,
 @shipping_address=
  #<Spreedly::ShippingAddress:0x007f9062bbba58
   @address1="",
   @address2="",
   @city="",
   @country="",
   @name="Robert Lemke",
   @phone_number="",
   @state="",
   @zip="">,
 @state="succeeded",
 @succeeded="true",
 @token="S7EkCCm5jGzi8Fk39NMbWAccDo2",
 @updated_at="2016-08-11T17:14:59Z">