Class: ActiveMerchant::Billing::Gateway
- Inherits:
-
Object
- Object
- ActiveMerchant::Billing::Gateway
- 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.
Implementing new gateways
Direct Known Subclasses
AlliedWalletGateway, AuthorizeNetArbGateway, AuthorizeNetCimGateway, AuthorizeNetGateway, AxcessmsGateway, BalancedGateway, BankFrickGateway, BanwireGateway, BarclaycardSmartpayGateway, BarclaysEpdqGateway, Be2billGateway, BeanstreamGateway, BeanstreamInteracGateway, BluePayGateway, BlueSnapGateway, BogusGateway, BorgunGateway, BpointGateway, BraintreeBlueGateway, BraintreeGateway, BridgePayGateway, CC5Gateway, CamsGateway, CardStreamGateway, CardknoxGateway, CashnetGateway, CecabankGateway, CenposGateway, CheckoutGateway, CheckoutV2Gateway, CitrusPayGateway, ClearhausGateway, CommercegateGateway, ConektaGateway, CreditcallGateway, CredoraxGateway, CyberSourceGateway, DataCashGateway, DibsGateway, EfsnetGateway, ElavonGateway, ElementGateway, EpayGateway, EvoCaGateway, EwayGateway, EwayManagedGateway, EwayRapidGateway, ExactGateway, EzicGateway, FatZebraGateway, FederatedCanadaGateway, FirstGivingGateway, FirstPayGateway, FirstdataE4Gateway, Flo2cashGateway, ForteGateway, GarantiGateway, GlobalCollectGateway, GlobalTransportGateway, HdfcGateway, HpsGateway, IatsPaymentsGateway, IdealBaseGateway, InspireGateway, InstapayGateway, IppGateway, IridiumGateway, ItransactGateway, JetpayGateway, KomojuGateway, Latitude19Gateway, LinkpointGateway, LitleGateway, MaxipagoGateway, MerchantESolutionsGateway, MerchantOneGateway, MerchantPartnersGateway, MerchantWareGateway, MerchantWareVersionFourGateway, MerchantWarriorGateway, MercuryGateway, MetricsGlobalGateway, MicropaymentGateway, MigsGateway, ModernPaymentsCimGateway, ModernPaymentsGateway, MoneiGateway, MonerisGateway, MonerisUsGateway, MoneyMoversGateway, NabTransactGateway, NcrSecurePayGateway, NetRegistryGateway, NetaxeptGateway, NetbanxGateway, NetbillingGateway, NetpayGateway, NetworkMerchantsGateway, NmiGateway, OgoneGateway, OmiseGateway, OpenpayGateway, OppGateway, OptimalPaymentGateway, OrbitalGateway, PacNetRavenGateway, PagarmeGateway, PagoFacilGateway, PayConexGateway, PayGateXmlGateway, PayHubGateway, PayJunctionGateway, PayJunctionV2Gateway, PaySecureGateway, PayboxDirectGateway, PayeezyGateway, PayexGateway, PayflowExpressGateway, PayflowGateway, PaymentExpressGateway, PaymillGateway, PaypalExpressGateway, PaypalGateway, PayscoutGateway, PaystationGateway, PayuInGateway, PayuLatamGateway, PaywayGateway, PinGateway, PlugnpayGateway, PsigateGateway, PslCardGateway, QbmsGateway, QuantumGateway, QuickbooksGateway, QuickpayGateway, QuickpayV10Gateway, QuickpayV4to7Gateway, QvalentGateway, RealexGateway, RedsysGateway, S5Gateway, SageGateway, SagePayGateway, SallieMaeGateway, SecureNetGateway, SecurePayAuGateway, SecurePayGateway, SecurePayTechGateway, SecurionPayGateway, SkipJackGateway, SmartPs, SoEasyPayGateway, SpreedlyCoreGateway, StripeGateway, SwipeCheckoutGateway, TelrGateway, TnsGateway, TransFirstGateway, TransFirstTransactionExpressGateway, TransactProGateway, TrustCommerceGateway, UsaEpayAdvancedGateway, UsaEpayGateway, UsaEpayTransactionGateway, VancoGateway, VerifiGateway, ViaklixGateway, VisanetPeruGateway, WepayGateway, WirecardGateway, WorldNetGateway, WorldpayGateway, WorldpayOnlinePaymentsGateway, WorldpayUsGateway
Constant Summary collapse
- DEBIT_CARDS =
[ :switch, :solo ]
- 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 does not match correct formatting :invalid_cvc - Security codes does not match correct format (3-4 digits) :expired_card - Card number is expired :incorrect_cvc - Security 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 :test_mode_live_card - Card was declined. Request was in test mode, but used a non test card.
{ :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', :config_error => 'config_error', :test_mode_live_card => 'test_mode_live_card' }
- @@implementations =
[]
Instance Attribute Summary collapse
-
#options ⇒ Object
readonly
Returns the value of attribute options.
Class Method Summary collapse
- .card_brand(source) ⇒ Object
- .inherited(subclass) ⇒ Object
- .supported_countries ⇒ Object
- .supported_countries=(country_codes) ⇒ Object
-
.supports?(card_type) ⇒ Boolean
Use this method to check if your gateway of interest supports a credit card of some type.
Instance Method Summary collapse
- #card_brand(source) ⇒ Object
- #generate_unique_id ⇒ Object
-
#initialize(options = {}) ⇒ Gateway
constructor
Initialize a new gateway.
- #scrub(transcript) ⇒ Object
- #supported_countries ⇒ Object
- #supports_network_tokenization? ⇒ Boolean
-
#supports_scrubbing? ⇒ Boolean
Does this gateway know how to scrub sensitive information out of HTTP transcripts?.
-
#test? ⇒ Boolean
Are we running in test mode?.
Methods included from CreditCardFormatting
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.
178 179 180 |
# File 'lib/active_merchant/billing/gateway.rb', line 178 def initialize( = {}) @options = end |
Instance Attribute Details
#options ⇒ Object (readonly)
Returns the value of attribute options.
141 142 143 |
# File 'lib/active_merchant/billing/gateway.rb', line 141 def @options end |
Class Method Details
.card_brand(source) ⇒ Object
148 149 150 151 |
# File 'lib/active_merchant/billing/gateway.rb', line 148 def self.card_brand(source) result = source.respond_to?(:brand) ? source.brand : source.type result.to_s.downcase end |
.inherited(subclass) ⇒ Object
102 103 104 105 |
# File 'lib/active_merchant/billing/gateway.rb', line 102 def self.inherited(subclass) super @@implementations << subclass end |
.supported_countries ⇒ Object
162 163 164 |
# File 'lib/active_merchant/billing/gateway.rb', line 162 def self.supported_countries @supported_countries ||= [] end |
.supported_countries=(country_codes) ⇒ Object
153 154 155 156 157 158 159 160 |
# File 'lib/active_merchant/billing/gateway.rb', line 153 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
144 145 146 |
# File 'lib/active_merchant/billing/gateway.rb', line 144 def self.supports?(card_type) supported_cardtypes.include?(card_type.to_sym) end |
Instance Method Details
#card_brand(source) ⇒ Object
170 171 172 |
# File 'lib/active_merchant/billing/gateway.rb', line 170 def card_brand(source) self.class.card_brand(source) end |
#generate_unique_id ⇒ Object
107 108 109 |
# File 'lib/active_merchant/billing/gateway.rb', line 107 def generate_unique_id SecureRandom.hex(16) end |
#scrub(transcript) ⇒ Object
192 193 194 |
# File 'lib/active_merchant/billing/gateway.rb', line 192 def scrub(transcript) raise RuntimeError.new("This gateway does not support scrubbing.") end |
#supported_countries ⇒ Object
166 167 168 |
# File 'lib/active_merchant/billing/gateway.rb', line 166 def supported_countries self.class.supported_countries end |
#supports_network_tokenization? ⇒ Boolean
196 197 198 |
# File 'lib/active_merchant/billing/gateway.rb', line 196 def supports_network_tokenization? false end |
#supports_scrubbing? ⇒ Boolean
Does this gateway know how to scrub sensitive information out of HTTP transcripts?
188 189 190 |
# File 'lib/active_merchant/billing/gateway.rb', line 188 def supports_scrubbing? false end |