Method: ActiveMerchant::Billing::UsaEpayAdvancedGateway#run_customer_transaction

Defined in:

lib/active_merchant/billing/gateways/usa_epay_advanced.rb

#run_customer_transaction(options = {}) ⇒ Object

Run a transaction for an existing customer in the database.

Required Options

• :customer_number – gateway assigned identifier

• :command – Sale, AuthOnly, Credit, Check, CheckCredit

• :amount – total amount

Options

• :method_id – which payment method to use, 0/nil/omitted for default method

• :ignore_duplicate – true overrides duplicate transaction

• :client_ip – client ip address

• :customer_receipt – true, sends receipt to customer. active_merchant defaults to false

• :customer_email – specify if different than customer record

• :customer_template – name of template

• :merchant_receipt – true, sends receipt to merchant. active_merchant defaults to false

• :merchant_email – required if :merchant_receipt set to true

• :merchant_template – name of template

• :recurring – defaults to false *see documentation*

• :verification_value – pci forbids storage of this value, only required for CVV2 validation

• :software – active_merchant sets to required gateway option value

• :line_items – XXX not implemented yet

• :custom_fields – XXX not implemented yet

Transaction Options

• :invoice – transaction invoice number; truncated to 10 characters; defaults to reference_number

• :po_number – commercial purchase order number; upto 25 characters

• :order_id – should be used to assign a unique id; upto 64 characters

• :clerk – sales clerk

• :terminal – terminal name

• :table – table name/number

• :description – description

• :comments – comments

• :allow_partial_auth – allow partial authorization if full amount is not available; defaults false

• :currency – numeric currency code

• :tax – tax portion of amount

• :tip – tip portion of amount

• :non_tax – true if transaction is non-taxable

• :shipping – shipping portion of amount

• :discount – amount of discount

• :subtotal – amount of transaction before tax, tip, shipping, and discount are applied

Response

• #message – transaction response hash

# File 'lib/active_merchant/billing/gateways/usa_epay_advanced.rb', line 610

def run_customer_transaction(options = {})
  requires! options, :customer_number, :command, :amount

  request = build_request(__method__, options)
  commit(__method__, request)
end