Orbital Gateway Guide

close

Services and Compatibility

Payment Gateway Company Name:
Orbital
Services that work with Spreedly:
  • PaymentTech Orbital Gateway (Salem/Stratus Platform)
Services that do not work with Spreedly:
  • PNS/Tandem/Tampa Platform
Supported operations:
Purchase, Authorize, Capture, Refund, Void, Verify
Regions:
North America

Authentication and Security

Specific names for credentials:
default mode:
Login, Merchant ID, Password
merchant_id_only mode:
Merchant ID

Onboarding Merchants in:

Additional Notes

Orbital also operates as Chase PaymenTech. If you are looking for a Chase PaymenTech integration, use the orbital gateway type as described here.

We typically recommend using Merchant ID only mode for faster set-up. If you need to use your own credentials please email IntegratorSupport@ChasePaymentech.com to ensure that your account is correctly configured to connect via Spreedly’s certified solution.

The IP addresses for white listing are listed here.

Adding using Merchant ID Only mode

You can add a Orbital gateway using just your merchant_id like so:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'Ll6fAtoVSTyVMlJEmtpoJV8S:RKOCG5D8D3fZxDSg504D0IxU2XD4Io5VXmyzdCtTivHFTTSy' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>orbital</gateway_type>
        <mode>merchant_id_only</mode>
        <merchant_id>your merchant id</merchant_id>
      </gateway>'

<gateway>
  <token>Fsh6K8uDrLYxdJkrbiNGj95t20W</token>
  <gateway_type>orbital</gateway_type>
  <name>Orbital</name>
  <description nil="true"/>
  <merchant_id>your merchant id</merchant_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">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>merchant_id</name>
      <value>your merchant id</value>
    </credential>
  </credentials>
  <gateway_specific_fields>
  </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:27Z</created_at>
  <updated_at type="dateTime">2016-08-11T17:15:27Z</updated_at>
  <mode>merchant_id_only</mode>
</gateway>

Adding using Merchant Credentials and Merchant ID mode

To add a Orbital gateway using your full set of credentials:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'Ll6fAtoVSTyVMlJEmtpoJV8S:RKOCG5D8D3fZxDSg504D0IxU2XD4Io5VXmyzdCtTivHFTTSy' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>orbital</gateway_type>
        <login>Your OrbitalConnectionUsername</login>
        <password>Your OrbitalConnectionPassword</password>
        <merchant_id>merchant id</merchant_id>
      </gateway>'

<gateway>
  <token>W80tZSG2UhPoswcbgQ13OcVzGGR</token>
  <gateway_type>orbital</gateway_type>
  <name>Orbital</name>
  <description nil="true"/>
  <login>Your OrbitalConnectionUsername</login>
  <merchant_id>merchant id</merchant_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">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 OrbitalConnectionUsername</value>
    </credential>
    <credential>
      <name>merchant_id</name>
      <value>merchant id</value>
    </credential>
  </credentials>
  <gateway_specific_fields>
    <gateway_specific_field>soft_descriptors</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">2017-05-31T20:51:28Z</created_at>
  <updated_at type="dateTime">2017-05-31T20:51:29Z</updated_at>
  <mode>default</mode>
</gateway>


env = Spreedly::Environment.new('Ll6fAtoVSTyMlJEm', 'RKcG5D8D3fZxDSg504U2XD4Io5VXz')
env.add_gateway(:orbital, login: "Your OrbitalConnectionUsername", password: "Your OrbitalConnectionPassword",
                merchant_id: "Your merchant_id")


#<Spreedly::Gateway:0x007fd56bada3e8
 @created_at="2016-08-11T17:15:27Z",
 @credentials=
  {"login"=>"Your OrbitalConnectionUsername",
   "merchant_id"=>"Your merchant_id"},
 @gateway_type="orbital",
 @name="Orbital",
 @state="retained",
 @token="QD6R5vnsR9hFyy7pJnS0JAKGoO7",
 @updated_at="2016-08-11T17:15:27Z">

Optional Gateway Specific Fields

When interacting with a Orbital 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. Note that Orbital will not process transactions if more than one of the following are included: city, phone, url, email. Furthermore, there are character limits for most fields; please refer Orbital/Chase Paymentech docs for further details.


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>
          <orbital>
            <soft_descriptors>
              <merchant_name>Merch</merchant_name>
              <product_description>Proddesc</product_description>
              <merchant_city>Durham</merchant_city>
              <merchant_phone>8885551212</merchant_phone>
              <merchant_url>dotcom</merchant_url>
              <merchant_email>email</merchant_email>
            </soft_descriptors>
          </orbital>
        </gateway_specific_fields>
      </transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2017-06-01T15:34:28Z</created_at>
  <updated_at type="dateTime">2017-06-01T15:34:29Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>WeGasvwbMoHYp3j4HuKpMd3nNNL</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>
    <orbital>
      <soft_descriptors>
        <merchant_name>Merch</merchant_name>
        <product_description>Proddesc</product_description>
        <merchant_city>Durham</merchant_city>
        <merchant_phone>8885551212</merchant_phone>
        <merchant_url>dotcom</merchant_url>
        <merchant_email>email</merchant_email>
      </soft_descriptors>
    </orbital>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>51</gateway_transaction_id>
  <gateway_latency_ms type="integer">21</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>HW8ineDHN6A6b5qvZzeP2AlPt41</gateway_token>
  <shipping_address>
    <name>Danyka Lebsack</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-06-01T15:34:28Z</created_at>
    <updated_at type="dateTime">2017-06-01T15:34:29Z</updated_at>
  </response>
  <api_urls>
  </api_urls>
  <payment_method>
    <token>IX9U9LT5hiz4r7NEc8N0XjFACsn</token>
    <created_at type="dateTime">2017-05-15T19:45:57Z</created_at>
    <updated_at type="dateTime">2017-05-31T20:35:45Z</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>Danyka</first_name>
    <last_name>Lebsack</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>Danyka Lebsack</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>

If you’d like to request any gateway_specific_fields or gateway_specific_response_fields, please email support@spreedly.com with your request and the gateway documentation for the fields of interest.