Class: ActiveMerchant::Billing::OrbitalGateway

Inherits:
Gateway
  • Object
show all
Defined in:
lib/active_merchant/billing/gateways/orbital.rb,
lib/active_merchant/billing/gateways/orbital/avs_result.rb

Overview

For more information on Orbital, visit the integration center

Authentication Options

The Orbital Gateway supports two methods of authenticating incoming requests: Source IP authentication and Connection Username/Password authentication

In addition, these IP addresses/Connection Usernames must be affiliated with the Merchant IDs for which the client should be submitting transactions.

This does allow Third Party Hosting service organizations presenting on behalf of other merchants to submit transactions. However, each time a new customer is added, the merchant or Third-Party hosting organization needs to ensure that the new Merchant IDs or Chain IDs are affiliated with the hosting companies IPs or Connection Usernames.

If the merchant expects to have more than one merchant account with the Orbital Gateway, it should have its IP addresses/Connection Usernames affiliated at the Chain level hierarchy within the Orbital Gateway. Each time a new merchant ID is added, as long as it is placed within the same Chain, it will simply work. Otherwise, the additional MIDs will need to be affiliated with the merchant IPs or Connection Usernames respectively. For example, we generally affiliate all Salem accounts [BIN 000001] with their Company Number [formerly called MA #] number so all MIDs or Divisions under that Company will automatically be affiliated.

Defined Under Namespace

Classes: AVSResult

Constant Summary collapse

API_VERSION = 
"5.6"
POST_HEADERS = 
{
  "MIME-Version" => "1.1",
  "Content-Type" => "application/PTI56",
  "Content-transfer-encoding" => "text",
  "Request-number" => '1',
  "Document-type" => "Request",
  "Interface-Version" => "Ruby|ActiveMerchant|Proprietary Gateway"
}
AVS_SUPPORTED_COUNTRIES = 
['US', 'CA', 'UK', 'GB']
CURRENCY_CODES = 
{
  "AUD" => '036',
  "CAD" => '124',
  "CZK" => '203',
  "DKK" => '208',
  "HKD" => '344',
  "ICK" => '352',
  "JPY" => '392',
  "MXN" => '484',
  "NZD" => '554',
  "NOK" => '578',
  "SGD" => '702',
  "SEK" => '752',
  "CHF" => '756',
  "GBP" => '826',
  "USD" => '840',
  "EUR" => '978'
}
CURRENCY_EXPONENTS = 
{
  "AUD" => '2',
  "CAD" => '2',
  "CZK" => '2',
  "DKK" => '2',
  "HKD" => '2',
  "ICK" => '2',
  "JPY" => '0',
  "MXN" => '2',
  "NZD" => '2',
  "NOK" => '2',
  "SGD" => '2',
  "SEK" => '2',
  "CHF" => '2',
  "GBP" => '2',
  "USD" => '2',
  "EUR" => '2'
}
ECOMMERCE_TRANSACTION =

INDUSTRY TYPES

'EC'
RECURRING_PAYMENT_TRANSACTION = 
'RC'
MAIL_ORDER_TELEPHONE_ORDER_TRANSACTION = 
'MO'
INTERACTIVE_VOICE_RESPONSE = 
'IV'
AUTH_ONLY =

Auth Only No Capture

'A'
AUTH_AND_CAPTURE =

AC - Auth and Capture = ‘AC’

'AC'
FORCE_AUTH_ONLY =

F - Force Auth No Capture and no online authorization = ‘F’

'F'
FORCE_AUTH_AND_CAPTURE =

FR - Force Auth No Capture and no online authorization = ‘FR’ FC - Force Auth and Capture no online authorization = ‘FC’

'FC'
REFUND =

Refund and Capture no online authorization

'R'
TAX_NOT_PROVIDED =

Tax Inds

0
TAX_INCLUDED = 
1
NON_TAXABLE_TRANSACTION = 
2
CREATE =

Customer Profile Actions

'C'
RETRIEVE = 
'R'
UPDATE = 
'U'
DELETE = 
'D'
RECURRING = 
'R'
DEFERRED = 
'D'
ACTIVE =

Status Profile Status Flag This field is used to set the status of a Customer Profile.

'A'
INACTIVE = 
'I'
MANUAL_SUSPEND = 
'MS'
NO_MAPPING_TO_ORDER_DATA =

CustomerProfileOrderOverrideInd Defines if any Order Data can be pre-populated from the Customer Reference Number (CustomerRefNum)

'NO'
USE_CRN_FOR_ORDER_ID = 
'OI'
USE_CRN_FOR_COMMENTS = 
'OD'
USE_CRN_FOR_ORDER_ID_AND_COMMENTS = 
'OA'
AUTO_GENERATE =

CustomerProfileFromOrderInd Method to use to Generate the Customer Profile Number When Customer Profile Action Type = Create, defines what the Customer Profile Number will be:

'A'
USE_CUSTOMER_REF_NUM =

Auto-Generate the CustomerRefNum

'S'
USE_ORDER_ID =

Use CustomerRefNum field

'O'
USE_COMMENTS =

Use OrderID field

'D'

Constants inherited from Gateway

Gateway::CREDIT_DEPRECATION_MESSAGE, Gateway::CURRENCIES_WITHOUT_FRACTIONS, Gateway::DEBIT_CARDS

Instance Attribute Summary

Attributes inherited from Gateway

#options

Instance Method Summary collapse

Methods inherited from Gateway

#card_brand, card_brand, inherited, supports?, #test?

Methods included from CreditCardFormatting

#format

Constructor Details

#initialize(options = {}) ⇒ OrbitalGateway

Use Comments field



159
160
161
162
163
 
# File 'lib/active_merchant/billing/gateways/orbital.rb', line 159

def initialize(options = {})
  requires!(options, :merchant_id)
  requires!(options, :login, :password) unless options[:ip_authentication]
  super
end

Instance Method Details

#add_customer_profile(creditcard, options = {}) ⇒ Object

Customer Profiles

:customer_ref_num should be set unless your happy with Orbital providing one

:customer_profile_order_override_ind can be set to map the CustomerRefNum to OrderID or Comments. Defaults to ‘NO’ - no mapping

'NO' - No mapping to order data
'OI' - Use <CustomerRefNum> for <OrderID>
'OD' - Use <CustomerRefNum> for <Comments>
'OA' - Use <CustomerRefNum> for <OrderID> and <Comments>

:order_default_description can be set optionally. 64 char max.

:order_default_amount can be set optionally. integer as cents.

:status defaults to Active

'A' - Active
'I' - Inactive
'MS'  - Manual Suspend



242
243
244
245
246
 
# File 'lib/active_merchant/billing/gateways/orbital.rb', line 242

def add_customer_profile(creditcard, options = {})
  options.merge!(:customer_profile_action => CREATE)
  order = build_customer_request_xml(creditcard, options)
  commit(order, :add_customer_profile)
end

#authorize(money, creditcard, options = {}) ⇒ Object

A – Authorization request



166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/active_merchant/billing/gateways/orbital.rb', line 166

def authorize(money, creditcard, options = {})
  order = build_new_order_xml(AUTH_ONLY, money, options) do |xml|
    add_creditcard(xml, creditcard, options[:currency])
    add_address(xml, creditcard, options)
    if @options[:customer_profiles]
      add_customer_data(xml, options)
      add_managed_billing(xml, options)
    end
  end
  commit(order, :authorize, options[:trace_number])
end

#capture(money, authorization, options = {}) ⇒ Object

MFC - Mark For Capture



192
193
194
 
# File 'lib/active_merchant/billing/gateways/orbital.rb', line 192

def capture(money, authorization, options = {})
  commit(build_mark_for_capture_xml(money, authorization, options), :capture)
end

#credit(money, authorization, options = {}) ⇒ Object 



205
206
207
208
 
# File 'lib/active_merchant/billing/gateways/orbital.rb', line 205

def credit(money, authorization, options= {})
  deprecated CREDIT_DEPRECATION_MESSAGE
  refund(money, authorization, options)
end

#delete_customer_profile(customer_ref_num) ⇒ Object 



260
261
262
263
264
 
# File 'lib/active_merchant/billing/gateways/orbital.rb', line 260

def delete_customer_profile(customer_ref_num)
  options = {:customer_profile_action => DELETE, :customer_ref_num => customer_ref_num}
  order = build_customer_request_xml(nil, options)
  commit(order, :delete_customer_profile)
end

#purchase(money, creditcard, options = {}) ⇒ Object

AC – Authorization and Capture



179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/active_merchant/billing/gateways/orbital.rb', line 179

def purchase(money, creditcard, options = {})
  order = build_new_order_xml(AUTH_AND_CAPTURE, money, options) do |xml|
    add_creditcard(xml, creditcard, options[:currency])
    add_address(xml, creditcard, options)
    if @options[:customer_profiles]
      add_customer_data(xml, options)
      add_managed_billing(xml, options)
    end
  end
  commit(order, :purchase, options[:trace_number])
end

#refund(money, authorization, options = {}) ⇒ Object

R – Refund request



197
198
199
200
201
202
203
 
# File 'lib/active_merchant/billing/gateways/orbital.rb', line 197

def refund(money, authorization, options = {})
  order = build_new_order_xml(REFUND, money, options.merge(:authorization => authorization)) do |xml|
    add_refund(xml, options[:currency])
    xml.tag! :CustomerRefNum, options[:customer_ref_num] if @options[:customer_profiles] && options[:profile_txn]
  end
  commit(order, :refund, options[:trace_number])
end

#retrieve_customer_profile(customer_ref_num) ⇒ Object 



254
255
256
257
258
 
# File 'lib/active_merchant/billing/gateways/orbital.rb', line 254

def retrieve_customer_profile(customer_ref_num)
  options = {:customer_profile_action => RETRIEVE, :customer_ref_num => customer_ref_num}
  order = build_customer_request_xml(nil, options)
  commit(order, :retrieve_customer_profile)
end

#update_customer_profile(creditcard, options = {}) ⇒ Object 



248
249
250
251
252
 
# File 'lib/active_merchant/billing/gateways/orbital.rb', line 248

def update_customer_profile(creditcard, options = {})
  options.merge!(:customer_profile_action => UPDATE)
  order = build_customer_request_xml(creditcard, options)
  commit(order, :update_customer_profile)
end

#void(authorization, options = {}, deprecated = {}) ⇒ Object 



210
211
212
213
214
215
216
217
218
 
# File 'lib/active_merchant/billing/gateways/orbital.rb', line 210

def void(authorization, options = {}, deprecated = {})
  if(!options.kind_of?(Hash))
    deprecated("Calling the void method with an amount parameter is deprecated and will be removed in a future version.")
    return void(options, deprecated.merge(:amount => authorization))
  end

  order = build_void_request_xml(authorization, options)
  commit(order, :void, options[:trace_number])
end