class ActiveMerchant::Billing::PayflowGateway
Constants
- RECURRING_ACTIONS
Public Instance Methods
# File lib/active_merchant/billing/gateways/payflow.rb, line 73 def cancel_recurring(profile_id) ActiveMerchant.deprecated RECURRING_DEPRECATION_MESSAGE request = build_recurring_request(:cancel, 0, :profile_id => profile_id) commit(request, options.merge(:request_type => :recurring)) end
# File lib/active_merchant/billing/gateways/payflow.rb, line 28 def credit(money, funding_source, options = {}) if funding_source.is_a?(String) ActiveMerchant.deprecated CREDIT_DEPRECATION_MESSAGE # Perform referenced credit refund(money, funding_source, options) elsif card_brand(funding_source) == 'check' # Perform non-referenced credit request = build_check_request(:credit, money, funding_source, options) commit(request, options) else request = build_credit_card_request(:credit, money, funding_source, options) commit(request, options) end end
# File lib/active_merchant/billing/gateways/payflow.rb, line 87 def express @express ||= PayflowExpressGateway.new(@options) end
# File lib/active_merchant/billing/gateways/payflow.rb, line 22 def purchase(money, funding_source, options = {}) request = build_sale_or_authorization_request(:purchase, money, funding_source, options) commit(request, options) end
Adds or modifies a recurring Payflow profile. See the Payflow Pro Recurring Billing
Guide for more details: www.paypal.com/en_US/pdf/PayflowPro_RecurringBilling_Guide.pdf
Several options are available to customize the recurring profile:
-
profile_id
- is only required for editing a recurring profile -
starting_at
- takes a Date, Time, or string in mmddyyyy format. The date must be in the future. -
name
- The name of the customer to be billed. If not specified, the name from the credit card is used. -
periodicity
- The frequency that the recurring payments will occur at. Can be one of
:bimonthly, :monthly, :biweekly, :weekly, :yearly, :daily, :semimonthly, :quadweekly, :quarterly, :semiyearly
-
payments
- The term, or number of payments that will be made -
comment
- A comment associated with the profile
# File lib/active_merchant/billing/gateways/payflow.rb, line 63 def recurring(money, credit_card, options = {}) ActiveMerchant.deprecated RECURRING_DEPRECATION_MESSAGE options[:name] = credit_card.name if options[:name].blank? && credit_card request = build_recurring_request(options[:profile_id] ? :modify : :add, money, options) do |xml| add_credit_card(xml, credit_card) if credit_card end commit(request, options.merge(:request_type => :recurring)) end
# File lib/active_merchant/billing/gateways/payflow.rb, line 80 def recurring_inquiry(profile_id, options = {}) ActiveMerchant.deprecated RECURRING_DEPRECATION_MESSAGE request = build_recurring_request(:inquiry, nil, options.update( :profile_id => profile_id )) commit(request, options.merge(:request_type => :recurring)) end
# File lib/active_merchant/billing/gateways/payflow.rb, line 43 def refund(money, reference, options = {}) commit(build_reference_request(:credit, money, reference, options), options) end
# File lib/active_merchant/billing/gateways/payflow.rb, line 47 def verify(payment, options={}) authorize(0, payment, options) end
Private Instance Methods
# File lib/active_merchant/billing/gateways/payflow.rb, line 190 def add_credit_card(xml, credit_card) xml.tag! 'Card' do xml.tag! 'CardType', credit_card_type(credit_card) xml.tag! 'CardNum', credit_card.number xml.tag! 'ExpDate', expdate(credit_card) xml.tag! 'NameOnCard', credit_card.first_name xml.tag! 'CVNum', credit_card.verification_value if credit_card.verification_value? if requires_start_date_or_issue_number?(credit_card) xml.tag!('ExtData', 'Name' => 'CardStart', 'Value' => startdate(credit_card)) unless credit_card.start_month.blank? || credit_card.start_year.blank? xml.tag!('ExtData', 'Name' => 'CardIssue', 'Value' => format(credit_card.issue_number, :two_digits)) unless credit_card.issue_number.blank? end xml.tag! 'ExtData', 'Name' => 'LASTNAME', 'Value' => credit_card.last_name end end
# File lib/active_merchant/billing/gateways/payflow.rb, line 165 def build_check_request(action, money, check, options) xml = Builder::XmlMarkup.new xml.tag! TRANSACTIONS[action] do xml.tag! 'PayData' do xml.tag! 'Invoice' do xml.tag! 'CustIP', options[:ip] unless options[:ip].blank? xml.tag! 'InvNum', options[:order_id].to_s.gsub(/[^\w.]/, '') unless options[:order_id].blank? xml.tag! 'Description', options[:description] unless options[:description].blank? xml.tag! 'BillTo' do xml.tag! 'Name', check.name end xml.tag! 'TotalAmt', amount(money), 'Currency' => options[:currency] || currency(money) end xml.tag! 'Tender' do xml.tag! 'ACH' do xml.tag! 'AcctType', check.account_type == 'checking' ? 'C' : 'S' xml.tag! 'AcctNum', check.account_number xml.tag! 'ABA', check.routing_number end end end end xml.target! end
# File lib/active_merchant/billing/gateways/payflow.rb, line 134 def build_credit_card_request(action, money, credit_card, options) xml = Builder::XmlMarkup.new xml.tag! TRANSACTIONS[action] do xml.tag! 'PayData' do xml.tag! 'Invoice' do xml.tag! 'CustIP', options[:ip] unless options[:ip].blank? xml.tag! 'InvNum', options[:order_id].to_s.gsub(/[^\w.]/, '') unless options[:order_id].blank? xml.tag! 'Description', options[:description] unless options[:description].blank? # Comment and Comment2 will show up in manager.paypal.com as Comment1 and Comment2 xml.tag! 'Comment', options[:comment] unless options[:comment].blank? xml.tag!('ExtData', 'Name'=> 'COMMENT2', 'Value'=> options[:comment2]) unless options[:comment2].blank? xml.tag! 'TaxAmt', options[:taxamt] unless options[:taxamt].blank? xml.tag! 'FreightAmt', options[:freightamt] unless options[:freightamt].blank? xml.tag! 'DutyAmt', options[:dutyamt] unless options[:dutyamt].blank? xml.tag! 'DiscountAmt', options[:discountamt] unless options[:discountamt].blank? billing_address = options[:billing_address] || options[:address] add_address(xml, 'BillTo', billing_address, options) if billing_address add_address(xml, 'ShipTo', options[:shipping_address], options) if options[:shipping_address] xml.tag! 'TotalAmt', amount(money), 'Currency' => options[:currency] || currency(money) end xml.tag! 'Tender' do add_credit_card(xml, credit_card) end end end xml.target! end
# File lib/active_merchant/billing/gateways/payflow.rb, line 226 def build_recurring_request(action, money, options) unless RECURRING_ACTIONS.include?(action) raise StandardError, "Invalid Recurring Profile Action: #{action}" end xml = Builder::XmlMarkup.new xml.tag! 'RecurringProfiles' do xml.tag! 'RecurringProfile' do xml.tag! action.to_s.capitalize do unless [:cancel, :inquiry].include?(action) xml.tag! 'RPData' do xml.tag! 'Name', options[:name] unless options[:name].nil? xml.tag! 'TotalAmt', amount(money), 'Currency' => options[:currency] || currency(money) xml.tag! 'PayPeriod', get_pay_period(options) xml.tag! 'Term', options[:payments] unless options[:payments].nil? xml.tag! 'Comment', options[:comment] unless options[:comment].nil? xml.tag! 'RetryNumDays', options[:retry_num_days] unless options[:retry_num_days].nil? xml.tag! 'MaxFailPayments', options[:max_fail_payments] unless options[:max_fail_payments].nil? if initial_tx = options[:initial_transaction] requires!(initial_tx, [:type, :authorization, :purchase]) requires!(initial_tx, :amount) if initial_tx[:type] == :purchase xml.tag! 'OptionalTrans', TRANSACTIONS[initial_tx[:type]] xml.tag! 'OptionalTransAmt', amount(initial_tx[:amount]) unless initial_tx[:amount].blank? end if action == :add xml.tag! 'Start', format_rp_date(options[:starting_at] || Date.today + 1 ) else xml.tag! 'Start', format_rp_date(options[:starting_at]) unless options[:starting_at].nil? end xml.tag! 'EMail', options[:email] unless options[:email].nil? billing_address = options[:billing_address] || options[:address] add_address(xml, 'BillTo', billing_address, options) if billing_address add_address(xml, 'ShipTo', options[:shipping_address], options) if options[:shipping_address] end xml.tag! 'Tender' do yield xml end end if action != :add xml.tag! "ProfileID", options[:profile_id] end if action == :inquiry xml.tag! "PaymentHistory", ( options[:history] ? 'Y' : 'N' ) end end end end end
# File lib/active_merchant/billing/gateways/payflow.rb, line 302 def build_response(success, message, response, options = {}) PayflowResponse.new(success, message, response, options) end
# File lib/active_merchant/billing/gateways/payflow.rb, line 206 def credit_card_type(credit_card) return '' if card_brand(credit_card).blank? CARD_MAPPING[card_brand(credit_card).to_sym] end
# File lib/active_merchant/billing/gateways/payflow.rb, line 212 def expdate(creditcard) year = sprintf("%.4i", creditcard.year.to_s.sub(/^0+/, '')) month = sprintf("%.2i", creditcard.month.to_s.sub(/^0+/, '')) "#{year}#{month}" end
# File lib/active_merchant/billing/gateways/payflow.rb, line 294 def format_rp_date(time) case time when Time, Date then time.strftime("%m%d%Y") else time.to_s end end
# File lib/active_merchant/billing/gateways/payflow.rb, line 280 def get_pay_period(options) requires!(options, [:periodicity, :bimonthly, :monthly, :biweekly, :weekly, :yearly, :daily, :semimonthly, :quadweekly, :quarterly, :semiyearly]) case options[:periodicity] when :weekly then 'Weekly' when :biweekly then 'Bi-weekly' when :semimonthly then 'Semi-monthly' when :quadweekly then 'Every four weeks' when :monthly then 'Monthly' when :quarterly then 'Quarterly' when :semiyearly then 'Semi-yearly' when :yearly then 'Yearly' end end
# File lib/active_merchant/billing/gateways/payflow.rb, line 219 def startdate(creditcard) year = format(creditcard.start_year, :two_digits) month = format(creditcard.start_month, :two_digits) "#{month}#{year}" end