Class: ActiveMerchant::Billing::Gateway

Inherits:
Object
  • Object
show all
Includes:
CreditCardFormatting, PostsData
Defined in:
lib/active_merchant/billing/gateway.rb

Overview

Description

The Gateway class is the base class for all ActiveMerchant gateway implementations.

The standard list of gateway functions that most concrete gateway subclasses implement is:

  • purchase(money, credit_card, options = {})

  • authorize(money, credit_card, options = {})

  • capture(money, authorization, options = {})

  • void(identification, options = {})

  • refund(money, identification, options = {})

  • verify(credit_card, options = {})

Some gateways also support features for storing credit cards:

  • store(credit_card, options = {})

  • unstore(identification, options = {})

Gateway Options

The options hash consists of the following options:

  • :order_id - The order number

  • :ip - The IP address of the customer making the purchase

  • :customer - The name, customer number, or other information that identifies the customer

  • :invoice - The invoice number

  • :merchant - The name or description of the merchant offering the product

  • :description - A description of the transaction

  • :email - The email address of the customer

  • :currency - The currency of the transaction. Only important when you are using a currency that is not the default with a gateway that supports multiple currencies.

  • :billing_address - A hash containing the billing address of the customer.

  • :shipping_address - A hash containing the shipping address of the customer.

The :billing_address, and :shipping_address hashes can have the following keys:

  • :name - The full name of the customer.

  • :company - The company name of the customer.

  • :address1 - The primary street address of the customer.

  • :address2 - Additional line of address information.

  • :city - The city of the customer.

  • :state - The state of the customer. The 2 digit code for US and Canadian addresses. The full name of the state or province for foreign addresses.

  • :country - The [ISO 3166-1-alpha-2 code](www.iso.org/iso/country_codes/iso_3166_code_lists/english_country_names_and_code_elements.htm) for the customer.

  • :zip - The zip or postal code of the customer.

  • :phone - The phone number of the customer.

Implmenting new gateways

See the ActiveMerchant Guide to Contributing

Direct Known Subclasses

AlliedWalletGateway, App55Gateway, AuthorizeNetArbGateway, AuthorizeNetCimGateway, AuthorizeNetGateway, AxcessmsGateway, BalancedGateway, BankFrickGateway, BanwireGateway, BarclaysEpdqGateway, Be2billGateway, BeanstreamGateway, BeanstreamInteracGateway, BluePayGateway, BogusGateway, BorgunGateway, BpointGateway, BraintreeBlueGateway, BraintreeGateway, BridgePayGateway, CC5Gateway, CardStreamGateway, CashnetGateway, CecabankGateway, CenposGateway, CertoDirectGateway, CheckoutGateway, CheckoutV2Gateway, CommercegateGateway, ConektaGateway, CyberSourceGateway, DataCashGateway, DibsGateway, EfsnetGateway, ElavonGateway, EpayGateway, EvoCaGateway, EwayGateway, EwayManagedGateway, EwayRapidGateway, ExactGateway, EzicGateway, FatZebraGateway, FederatedCanadaGateway, FirstGivingGateway, FirstPayGateway, FirstdataE4Gateway, Flo2cashGateway, GarantiGateway, GlobalTransportGateway, HdfcGateway, HpsGateway, IatsPaymentsGateway, IdealBaseGateway, InspireGateway, InstapayGateway, IppGateway, IridiumGateway, ItransactGateway, JetpayGateway, LinkpointGateway, LitleGateway, MaxipagoGateway, MerchantESolutionsGateway, MerchantOneGateway, MerchantPartnersGateway, MerchantWareGateway, MerchantWareVersionFourGateway, MerchantWarriorGateway, MercuryGateway, MetricsGlobalGateway, MigsGateway, ModernPaymentsCimGateway, ModernPaymentsGateway, MoneiGateway, MonerisGateway, MonerisUsGateway, MoneyMoversGateway, NabTransactGateway, NetRegistryGateway, NetaxeptGateway, NetbillingGateway, NetpayGateway, NetworkMerchantsGateway, NmiGateway, OgoneGateway, OmiseGateway, OpenpayGateway, OptimalPaymentGateway, OrbitalGateway, PacNetRavenGateway, PagoFacilGateway, PayConexGateway, PayGateXmlGateway, PayHubGateway, PayJunctionGateway, PaySecureGateway, PayboxDirectGateway, PayexGateway, PayflowExpressGateway, PayflowGateway, PaymentExpressGateway, PaymillGateway, PaypalExpressGateway, PaypalGateway, PayscoutGateway, PaystationGateway, PayuInGateway, PaywayGateway, PinGateway, PlugnpayGateway, PsigateGateway, PslCardGateway, QbmsGateway, QuantumGateway, QuickbooksGateway, QuickpayGateway, QuickpayV10Gateway, QuickpayV4to7Gateway, QvalentGateway, RealexGateway, RedsysGateway, S5Gateway, SageBankcardGateway, SageGateway, SagePayGateway, SageVaultGateway, SageVirtualCheckGateway, SallieMaeGateway, SecureNetGateway, SecurePayAuGateway, SecurePayGateway, SecurePayTechGateway, SkipJackGateway, SmartPs, SoEasyPayGateway, SpreedlyCoreGateway, StripeGateway, SwipeCheckoutGateway, TnsGateway, TransFirstGateway, TrustCommerceGateway, UsaEpayAdvancedGateway, UsaEpayGateway, UsaEpayTransactionGateway, VancoGateway, VerifiGateway, ViaklixGateway, WepayGateway, WirecardGateway, WorldpayGateway, WorldpayOnlinePaymentsGateway, WorldpayUsGateway

Constant Summary collapse

DEBIT_CARDS = 
[ :switch, :solo ]
CURRENCIES_WITHOUT_FRACTIONS = 
[ 'BIF', 'BYR', 'CLP', 'CVE', 'DJF', 'GNF', 'HUF', 'ISK', 'JPY', 'KMF', 'KRW', 'PYG', 'RWF', 'TWD', 'UGX', 'VND', 'VUV', 'XAF', 'XOF', 'XPF' ]
CREDIT_DEPRECATION_MESSAGE = 
"Support for using credit to refund existing transactions is deprecated and will be removed from a future release of ActiveMerchant. Please use the refund method instead."
RECURRING_DEPRECATION_MESSAGE = 
"Recurring functionality in ActiveMerchant is deprecated and will be removed in a future version. Please contact the ActiveMerchant maintainers if you have an interest in taking ownership of a separate gem that continues support for it."
STANDARD_ERROR_CODE =

Standardized Error Codes

:incorrect_number - Card number does not comply with ISO/IEC 7812 numbering standard :invalid_number - Card number was not matched by processor :invalid_expiry_date - Expiry date deos not match correct formatting :invalid_cvc - Security codes does not match correct format (3-4 digits) :expired_card - Card number is expired :incorrect_cvc - Secerity code was not matched by the processor :incorrect_zip - Zip code is not in correct format :incorrect_address - Billing address info was not matched by the processor :incorrect_pin - Card PIN is incorrect :card_declined - Card number declined by processor :processing_error - Processor error :call_issuer - Transaction requires voice authentication, call issuer :pickup_card - Issuer requests that you pickup the card from merchant

{
  :incorrect_number => 'incorrect_number',
  :invalid_number => 'invalid_number',
  :invalid_expiry_date => 'invalid_expiry_date',
  :invalid_cvc => 'invalid_cvc',
  :expired_card => 'expired_card',
  :incorrect_cvc => 'incorrect_cvc',
  :incorrect_zip => 'incorrect_zip',
  :incorrect_address => 'incorrect_address',
  :incorrect_pin => 'incorrect_pin',
  :card_declined => 'card_declined',
  :processing_error => 'processing_error',
  :call_issuer => 'call_issuer',
  :pickup_card => 'pick_up_card'
}
@@implementations = 
[]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from CreditCardFormatting

#expdate, #format

Methods included from PostsData

included, #raw_ssl_request, #ssl_get, #ssl_post, #ssl_request

Constructor Details

#initialize(options = {}) ⇒ Gateway

Initialize a new gateway.

See the documentation for the gateway you will be using to make sure there are no other required options.



177
178
179
 
# File 'lib/active_merchant/billing/gateway.rb', line 177

def initialize(options = {})
  @options = options
end

Instance Attribute Details

#options ⇒ Object (readonly)

Returns the value of attribute options.



136
137
138
 
# File 'lib/active_merchant/billing/gateway.rb', line 136

def options
  @options
end

Class Method Details

.card_brand(source) ⇒ Object 



143
144
145
146
 
# File 'lib/active_merchant/billing/gateway.rb', line 143

def self.card_brand(source)
  result = source.respond_to?(:brand) ? source.brand : source.type
  result.to_s.downcase
end

.inherited(subclass) ⇒ Object 



100
101
102
103
 
# File 'lib/active_merchant/billing/gateway.rb', line 100

def self.inherited(subclass)
  super
  @@implementations << subclass
end

.non_fractional_currency?(currency) ⇒ Boolean

Returns:

  • (Boolean) 


148
149
150
 
# File 'lib/active_merchant/billing/gateway.rb', line 148

def self.non_fractional_currency?(currency)
  CURRENCIES_WITHOUT_FRACTIONS.include?(currency.to_s)
end

.supported_countries ⇒ Object 



161
162
163
 
# File 'lib/active_merchant/billing/gateway.rb', line 161

def self.supported_countries
  @supported_countries ||= []
end

.supported_countries=(country_codes) ⇒ Object 



152
153
154
155
156
157
158
159
 
# File 'lib/active_merchant/billing/gateway.rb', line 152

def self.supported_countries=(country_codes)
  country_codes.each do |country_code|
    unless ActiveMerchant::Country.find(country_code)
      raise ActiveMerchant::InvalidCountryCodeError, "No country could be found for the country #{country_code}"
    end
  end
  @supported_countries = country_codes.dup
end

.supports?(card_type) ⇒ Boolean

Use this method to check if your gateway of interest supports a credit card of some type

Returns:

  • (Boolean) 


139
140
141
 
# File 'lib/active_merchant/billing/gateway.rb', line 139

def self.supports?(card_type)
  supported_cardtypes.include?(card_type.to_sym)
end

Instance Method Details

#card_brand(source) ⇒ Object 



169
170
171
 
# File 'lib/active_merchant/billing/gateway.rb', line 169

def card_brand(source)
  self.class.card_brand(source)
end

#generate_unique_id ⇒ Object 



105
106
107
 
# File 'lib/active_merchant/billing/gateway.rb', line 105

def generate_unique_id
  SecureRandom.hex(16)
end

#scrub(transcript) ⇒ Object

Raises:

  • (RuntimeError) 


191
192
193
 
# File 'lib/active_merchant/billing/gateway.rb', line 191

def scrub(transcript)
  raise RuntimeError.new("This gateway does not support scrubbing.")
end

#supported_countries ⇒ Object 



165
166
167
 
# File 'lib/active_merchant/billing/gateway.rb', line 165

def supported_countries
  self.class.supported_countries
end

#supports_network_tokenization? ⇒ Boolean

Returns:

  • (Boolean) 


195
196
197
 
# File 'lib/active_merchant/billing/gateway.rb', line 195

def supports_network_tokenization?
  false
end

#supports_scrubbing? ⇒ Boolean

Does this gateway know how to scrub sensitive information out of HTTP transcripts?

Returns:

  • (Boolean) 


187
188
189
 
# File 'lib/active_merchant/billing/gateway.rb', line 187

def supports_scrubbing?
  false
end

#test? ⇒ Boolean

Are we running in test mode?

Returns:

  • (Boolean) 


182
183
184
 
# File 'lib/active_merchant/billing/gateway.rb', line 182

def test?
  (@options.has_key?(:test) ? @options[:test] : Base.test?)
end