Class: ActiveMerchant::Billing::NabTransactGateway

Inherits:
Gateway
  • Object
show all
Defined in:
lib/active_merchant/billing/gateways/nab_transact.rb

Overview

The National Australia Bank provide a payment gateway that seems to be a rebadged Securepay Australia service, though some differences exist.

Constant Summary

API_VERSION =
'xml-4.2'
PERIODIC_API_VERSION =
"spxml-4.2"
TRANSACTIONS =

Transactions currently accepted by NAB Transact XML API

{
  :purchase => 0,         #Standard Payment
  :refund => 4,           #Refund
  :void => 6,             #Client Reversal (Void)
  :authorization => 10,   #Preauthorise
  :capture => 11          #Preauthorise Complete (Advice)
}
PERIODIC_TYPES =
{
  :addcrn    => 5,
  :editcrn   => 5,
  :deletecrn => 5,
  :trigger   => 8
}
SUCCESS_CODES =
[ '00', '08', '11', '16', '77' ]

Constants inherited from Gateway

Gateway::CREDIT_DEPRECATION_MESSAGE, Gateway::CURRENCIES_WITHOUT_FRACTIONS, Gateway::DEBIT_CARDS

Instance Attribute Summary

Attributes inherited from Gateway

#options

Instance Method Summary (collapse)

Methods inherited from Gateway

card_brand, #card_brand, inherited, supports?, #test?

Methods included from CreditCardFormatting

#format

Constructor Details

- (NabTransactGateway) initialize(options = {})

Returns a new instance of NabTransactGateway



53
54
55
56
# File 'lib/active_merchant/billing/gateways/nab_transact.rb', line 53

def initialize(options = {})
  requires!(options, :login, :password)
  super
end

Instance Method Details

- (Object) authorize(money, credit_card, options = {})



73
74
75
# File 'lib/active_merchant/billing/gateways/nab_transact.rb', line 73

def authorize(money, credit_card, options = {})
  commit :authorization, build_purchase_request(money, credit_card, options)
end

- (Object) capture(money, authorization, options = {})



77
78
79
# File 'lib/active_merchant/billing/gateways/nab_transact.rb', line 77

def capture(money, authorization, options = {})
  commit :capture, build_reference_request(money, authorization, options)
end

- (Object) purchase(money, credit_card_or_stored_id, options = {})



58
59
60
61
62
63
64
65
66
67
# File 'lib/active_merchant/billing/gateways/nab_transact.rb', line 58

def purchase(money, credit_card_or_stored_id, options = {})
  if credit_card_or_stored_id.respond_to?(:number)
    #Credit card for instant payment
    commit :purchase, build_purchase_request(money, credit_card_or_stored_id, options)
  else
    #Triggered payment for an existing stored credit card
    options[:billing_id] = credit_card_or_stored_id.to_s
    commit_periodic build_periodic_item(:trigger, money, nil, options)
  end
end

- (Object) refund(money, authorization, options = {})



69
70
71
# File 'lib/active_merchant/billing/gateways/nab_transact.rb', line 69

def refund(money, authorization, options = {})
  commit :refund, build_reference_request(money, authorization, options)
end

- (Object) store(creditcard, options = {})



81
82
83
84
# File 'lib/active_merchant/billing/gateways/nab_transact.rb', line 81

def store(creditcard, options = {})
  requires!(options, :billing_id, :amount)
  commit_periodic(build_periodic_item(:addcrn, options[:amount], creditcard, options))
end

- (Object) unstore(identification, options = {})



86
87
88
89
# File 'lib/active_merchant/billing/gateways/nab_transact.rb', line 86

def unstore(identification, options = {})
  options[:billing_id] = identification
  commit_periodic(build_periodic_item(:deletecrn, options[:amount], nil, options))
end