Orbital (Chase Paymentech) Gateway Guide

close

Services and Compatibility

Payment Gateway Company Name:
Orbital (Chase Paymentech)
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
Supported payment types:
Credit Card, Apple Pay, Android Pay
Regions:
North America
API endpoint URL:
https://orbital1.chasepaymentech.com/authorize

Authentication and Security

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

Onboarding Merchants in:

Additional Notes

We typically recommend using Merchant ID only mode for faster set-up. The IP addresses for white listing are listed here. Additionally, in order to use Spreedly on the Tampa/Tandem platform, you’ll need to either use the Authorize.Net or CardConnect gateways.

Adding using Merchant ID Only mode

You can add a Orbital (Chase Paymentech) gateway using just your merchant_id like so:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -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>GPD4N7LBHN01JQ3vrB2uQONzJ9E</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_field>soft_descriptors</gateway_specific_field>
    <gateway_specific_field>level_2_data</gateway_specific_field>
  </gateway_specific_fields>
  <payment_methods>
    <payment_method>credit_card</payment_method>
    <payment_method>apple_pay</payment_method>
    <payment_method>android_pay</payment_method>
  </payment_methods>
  <state>retained</state>
  <redacted type="boolean">false</redacted>
  <created_at type="dateTime">2017-08-24T15:55:57Z</created_at>
  <updated_at type="dateTime">2017-08-24T15:55:57Z</updated_at>
  <mode>merchant_id_only</mode>
</gateway>

Adding using Merchant Credentials and Merchant ID mode

To add a Orbital (Chase Paymentech) gateway using your full set of credentials:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -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>5KJyuJxYTxfLxaAm1eUD8aD5Uu</token>
  <gateway_type>orbital</gateway_type>
  <name>Orbital (Chase Paymentech)</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>
  </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_field>level_2_data</gateway_specific_field>
    <gateway_specific_field>mit_msg_type</gateway_specific_field>
    <gateway_specific_field>mit_stored_credential_ind</gateway_specific_field>
    <gateway_specific_field>mit_submitted_transaction_id</gateway_specific_field>
  </gateway_specific_fields>
  <payment_methods>
    <payment_method>credit_card</payment_method>
    <payment_method>apple_pay</payment_method>
    <payment_method>android_pay</payment_method>
  </payment_methods>
  <state>retained</state>
  <redacted type="boolean">false</redacted>
  <created_at type="dateTime">2019-01-22T20:25:50Z</created_at>
  <updated_at type="dateTime">2019-01-22T20:25:50Z</updated_at>
  <mode>default</mode>
</gateway>


env = Spreedly::Environment.new('C7cRfNJGODKh4Iu5Ox3PToKjniY', '4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ', base_url: 'https://core.spreedly.com')
env.add_gateway(:orbital, login: "Your OrbitalConnectionUsername", password: "Your OrbitalConnectionPassword",
                merchant_id: "Your merchant_id")


#<Spreedly::Gateway:0x007fa96d27a308
 @created_at="2017-08-22T14:20:42Z",
 @credentials=
  {"login"=>"Your OrbitalConnectionUsername",
   "merchant_id"=>"Your merchant_id"},
 @gateway_type="orbital",
 @name="Orbital",
 @state="retained",
 @token="ROPQJRQcjMA4RFmFcrgEgDVDrRo",
 @updated_at="2017-08-22T14:20:42Z">

Stored Credential Gateway Specific Fields

A Orbital (Chase Paymentech) gateway supports our standardized Stored Credential Data fields. However, we also allow a few gateway specific fields related to Stored Credentials to be specified, which will override the default Stored Credential Data fields. These fields are mit_msg_type, mit_stored_credential_ind, and mit_submitted_transaction_id. The overrides occur individually; for example, you could pass in a mit_msg_type of CGEN, but use the default fields for everything else.

For more information on the accepted values for these fields, please see Orbital’s “Stored Credentials Framework” documentation.

Optional Gateway Specific Fields

When interacting with a Orbital (Chase Paymentech) 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 '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>
          <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>
            <level_2_data>
              <tax_indicator>1</tax_indicator>
              <tax>1000</tax>
              <advice_addendum_1>advice-1</advice_addendum_1>
              <advice_addendum_2>advice-2</advice_addendum_2>
              <advice_addendum_3>advice-3</advice_addendum_3>
              <advice_addendum_4>advice-4</advice_addendum_4>
              <purchase_order>order12345</purchase_order>
              <name>Name</name>
              <address1>Address1</address1>
              <address2>Address2</address2>
              <city>City</city>
              <state>State</state>
              <zip>Zip</zip>
            </level_2_data>
            <mit_msg_type>MUSE</mit_msg_type>
            <mit_stored_credential_ind>Y</mit_stored_credential_ind>
            <mit_submitted_transaction_id>123456</mit_submitted_transaction_id>
          </orbital>
        </gateway_specific_fields>
      </transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2019-01-22T20:25:50Z</created_at>
  <updated_at type="dateTime">2019-01-22T20:25:50Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>WTtTClj270pAtvqyFYAhUp6lAV7</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>
      <level_2_data>
        <tax_indicator>1</tax_indicator>
        <tax>1000</tax>
        <advice_addendum_1>advice-1</advice_addendum_1>
        <advice_addendum_2>advice-2</advice_addendum_2>
        <advice_addendum_3>advice-3</advice_addendum_3>
        <advice_addendum_4>advice-4</advice_addendum_4>
        <purchase_order>order12345</purchase_order>
        <name>Name</name>
        <address1>Address1</address1>
        <address2>Address2</address2>
        <city>City</city>
        <state>State</state>
        <zip>Zip</zip>
      </level_2_data>
      <mit_msg_type>MUSE</mit_msg_type>
      <mit_stored_credential_ind>Y</mit_stored_credential_ind>
      <mit_submitted_transaction_id>123456</mit_submitted_transaction_id>
    </orbital>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>52</gateway_transaction_id>
  <gateway_latency_ms type="integer">20</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>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">2019-01-22T20:25:50Z</created_at>
    <updated_at type="dateTime">2019-01-22T20:25:50Z</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">2019-01-22T20:20:50Z</updated_at>
    <email>joey@example.com</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 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>e3cef43464fc832f6e04f187df25af497994</fingerprint>
  </payment_method>
</transaction>

If you’d like 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.