Class Index [+]

Quicksearch

ActiveMerchant::Billing::SageGateway

Public Class Methods

new(options = {}) click to toggle source

Creates a new SageGateway

The gateway requires that a valid login and password be passed in the options hash.

Options

  • :login - The Sage Payment Solutions Merchant ID Number.

  • :password - The Sage Payment Solutions Merchant Key Number.

    # File lib/active_merchant/billing/gateways/sage.rb, line 19
19:       def initialize(options = {})
20:         requires!(options, :login, :password)
21:         @options = options
22:         super
23:       end

Public Instance Methods

authorize(money, credit_card, options = {}) click to toggle source

Performs an authorization transaction

Parameters

  • money - The amount to be authorized as an integer value in cents.

  • credit_card - The CreditCard object to be used as the funding source for the transaction.

  • options - A hash of optional parameters.

    • :order_id - A unique reference for this order. (maximum of 20 characters).

    • :email - The customer’s email address

    • :customer - The Customer Number for Purchase Card Level II Transactions

    • :billing_address - The customer’s billing address as a hash of address information.

      • :address1 - The billing address street

      • :city - The billing address city

      • :state - The billing address state

      • :country - The 2 digit ISO billing address country code

      • :zip - The billing address zip code

      • :phone - The billing address phone number

      • :fax - The billing address fax number

    • :shipping_address - The customer’s shipping address as a hash of address information.

      • :name - The name at the shipping address

      • :address1 - The shipping address street

      • :city - The shipping address city

      • :state - The shipping address state code

      • :country - The 2 digit ISO shipping address country code

      • :zip - The shipping address zip code

    • :tax - The tax amount for the transaction as an Integer value in cents. Maps to Sage T_tax.

    • :shipping - The shipping amount for the transaction as an Integer value in cents. Maps to Sage T_shipping.

    # File lib/active_merchant/billing/gateways/sage.rb, line 51
51:       def authorize(money, credit_card, options = {})
52:         bankcard.authorize(money, credit_card, options)
53:       end
capture(money, reference, options = {}) click to toggle source

Captures authorized funds.

Parameters

  • money - The amount to be authorized as an integer value in cents. Sage doesn’t support changing the capture amount, so the full amount of the initial transaction will be captured.

  • reference - The authorization reference string returned by the original transaction’s Response#authorization.

     # File lib/active_merchant/billing/gateways/sage.rb, line 104
104:       def capture(money, reference, options = {})
105:         bankcard.capture(money, reference, options)
106:       end
credit(money, source, options = {}) click to toggle source

Performs a credit transaction. (Sage Credit transaction).

Parameters

  • money - The amount to be authorized as an integer value in cents.

  • source - The CreditCard or Check object to be used as the target for the credit.

     # File lib/active_merchant/billing/gateways/sage.rb, line 127
127:       def credit(money, source, options = {})
128:         if card_brand(source) == "check"
129:           virtual_check.credit(money, source, options)
130:         else
131:           bankcard.credit(money, source, options)
132:         end
133:       end
purchase(money, source, options = {}) click to toggle source

Performs a purchase, which is essentially an authorization and capture in a single operation.

Parameters

  • money - The amount to be authorized as an integer value in cents.

  • source - The CreditCard or Check object to be used as the funding source for the transaction.

  • options - A hash of optional parameters.

    • :order_id - A unique reference for this order. (maximum of 20 characters).

    • :email - The customer’s email address

    • :customer - The Customer Number for Purchase Card Level II Transactions

    • :billing_address - The customer’s billing address as a hash of address information.

      • :address1 - The billing address street

      • :city - The billing address city

      • :state - The billing address state

      • :country - The 2 digit ISO billing address country code

      • :zip - The billing address zip code

      • :phone - The billing address phone number

      • :fax - The billing address fax number

    • :shipping_address - The customer’s shipping address as a hash of address information.

      • :name - The name at the shipping address

      • :address1 - The shipping address street

      • :city - The shipping address city

      • :state - The shipping address state code

      • :country - The 2 digit ISO shipping address country code

      • :zip - The shipping address zip code

    • :tax - The tax amount for the transaction as an integer value in cents. Maps to Sage T_tax.

    • :shipping - The shipping amount for the transaction as an integer value in cents. Maps to Sage T_shipping.

Additional options in the options hash for when using a Check as the funding source

  • :originator_id - 10 digit originator. If not provided, Sage will use the default Originator ID for the specific customer type.

  • :addenda - Transaction addenda.

  • :ssn - The customer’s Social Security Number.

  • :drivers_license_state - The customer’s drivers license state code.

  • :drivers_license_number - The customer’s drivers license number.

  • :date_of_birth - The customer’s date of birth as a Time or Date object or a string in the format mm/dd/yyyy.

    # File lib/active_merchant/billing/gateways/sage.rb, line 90
90:       def purchase(money, source, options = {})
91:         if card_brand(source) == "check"
92:           virtual_check.purchase(money, source, options)
93:         else
94:           bankcard.purchase(money, source, options)
95:         end
96:       end
void(reference, options = {}) click to toggle source

Voids a prior transaction. Works for both CreditCard and Check transactions.

Parameters

  • reference - The authorization reference string returned by the original transaction’s Response#authorization.

     # File lib/active_merchant/billing/gateways/sage.rb, line 113
113:       def void(reference, options = {})
114:         if reference.split(";").last == "virtual_check"
115:           virtual_check.void(reference, options)
116:         else
117:           bankcard.void(reference, options)
118:         end
119:       end

Private Instance Methods

bankcard() click to toggle source
     # File lib/active_merchant/billing/gateways/sage.rb, line 136
136:       def bankcard
137:         @bankcard ||= SageBankcardGateway.new(@options)
138:       end
virtual_check() click to toggle source
     # File lib/active_merchant/billing/gateways/sage.rb, line 140
140:       def virtual_check
141:         @virtual_check ||= SageVirtualCheckGateway.new(@options)
142:       end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.