class ActiveMerchant::Billing::NabTransactGateway

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

Constants

API_VERSION
PERIODIC_API_VERSION
PERIODIC_TYPES
SUCCESS_CODES
TRANSACTIONS

Transactions currently accepted by NAB Transact XML API

Public Class Methods

new(options = {}) click to toggle source
Calls superclass method ActiveMerchant::Billing::Gateway::new
# File lib/active_merchant/billing/gateways/nab_transact.rb, line 46
def initialize(options = {})
  requires!(options, :login, :password)
  super
end

Public Instance Methods

authorize(money, credit_card, options = {}) click to toggle source
# File lib/active_merchant/billing/gateways/nab_transact.rb, line 70
def authorize(money, credit_card, options = {})
  commit :authorization, build_purchase_request(money, credit_card, options)
end
capture(money, authorization, options = {}) click to toggle source
# File lib/active_merchant/billing/gateways/nab_transact.rb, line 74
def capture(money, authorization, options = {})
  commit :capture, build_reference_request(money, authorization, options)
end
credit(money, credit_card, options = {}) click to toggle source
# File lib/active_merchant/billing/gateways/nab_transact.rb, line 62
def credit(money, credit_card, options = {})
  commit :unmatched_refund, build_purchase_request(money, credit_card, options)
end
purchase(money, credit_card_or_stored_id, options = {}) click to toggle source
# File lib/active_merchant/billing/gateways/nab_transact.rb, line 51
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
refund(money, authorization, options = {}) click to toggle source
# File lib/active_merchant/billing/gateways/nab_transact.rb, line 66
def refund(money, authorization, options = {})
  commit :refund, build_reference_request(money, authorization, options)
end
store(creditcard, options = {}) click to toggle source
# File lib/active_merchant/billing/gateways/nab_transact.rb, line 78
def store(creditcard, options = {})
  requires!(options, :billing_id, :amount)
  commit_periodic(build_periodic_item(:addcrn, options[:amount], creditcard, options))
end
unstore(identification, options = {}) click to toggle source
# File lib/active_merchant/billing/gateways/nab_transact.rb, line 83
def unstore(identification, options = {})
  options[:billing_id] = identification
  commit_periodic(build_periodic_item(:deletecrn, options[:amount], nil, options))
end

Private Instance Methods

add_metadata(xml, options) click to toggle source
# File lib/active_merchant/billing/gateways/nab_transact.rb, line 90
def add_metadata(xml, options)
  if options[:merchant_name] || options[:merchant_location]
    xml.tag! 'metadata' do
      xml.tag! 'meta', :name => 'ca_name', :value => options[:merchant_name] if options[:merchant_name]
      xml.tag! 'meta', :name => 'ca_location', :value => options[:merchant_location] if options[:merchant_location]
    end
  end
end
authorization_from(response) click to toggle source
# File lib/active_merchant/billing/gateways/nab_transact.rb, line 236
def authorization_from(response)
  [response[:txn_id], response[:purchase_order_no], response[:preauth_id], response[:amount]].join('*')
end
build_periodic_item(action, money, credit_card, options) click to toggle source
# File lib/active_merchant/billing/gateways/nab_transact.rb, line 166
def build_periodic_item(action, money, credit_card, options)
  xml = Builder::XmlMarkup.new

  xml.tag! 'actionType', action.to_s
  xml.tag! 'periodicType', PERIODIC_TYPES[action] if PERIODIC_TYPES[action]
  xml.tag! 'currency', options[:currency] || currency(money)
  xml.tag! 'crn', options[:billing_id]

  if credit_card
    xml.tag! 'CreditCardInfo' do
      xml.tag! 'cardNumber', credit_card.number
      xml.tag! 'expiryDate', expdate(credit_card)
      xml.tag! 'cvv', credit_card.verification_value if credit_card.verification_value?
    end
  end
  xml.tag! 'amount', amount(money)

  xml.target!
end
build_periodic_request(body) click to toggle source
# File lib/active_merchant/billing/gateways/nab_transact.rb, line 186
def build_periodic_request(body)
  xml = Builder::XmlMarkup.new
  xml.instruct!
  xml.tag! 'NABTransactMessage' do
    xml.tag! 'MessageInfo' do
      xml.tag! 'messageID', SecureRandom.hex(15)
      xml.tag! 'messageTimestamp', generate_timestamp
      xml.tag! 'timeoutValue', request_timeout
      xml.tag! 'apiVersion', PERIODIC_API_VERSION
    end

    xml.tag! 'MerchantInfo' do
      xml.tag! 'merchantID', @options[:login]
      xml.tag! 'password', @options[:password]
    end

    xml.tag! 'RequestType', 'Periodic'
    xml.tag! 'Periodic' do
      xml.tag! 'PeriodicList', "count" => 1 do
        xml.tag! 'PeriodicItem', "ID" => 1 do
          xml << body
        end
      end
    end
  end

  xml.target!
end
build_purchase_request(money, credit_card, options) click to toggle source
# File lib/active_merchant/billing/gateways/nab_transact.rb, line 99
def build_purchase_request(money, credit_card, options)
  xml = Builder::XmlMarkup.new
  xml.tag! 'amount', amount(money)
  xml.tag! 'currency', options[:currency] || currency(money)
  xml.tag! 'purchaseOrderNo', options[:order_id].to_s.gsub(/[ ']/, '')

  xml.tag! 'CreditCardInfo' do
    xml.tag! 'cardNumber', credit_card.number
    xml.tag! 'expiryDate', expdate(credit_card)
    xml.tag! 'cvv', credit_card.verification_value if credit_card.verification_value?
  end

  add_metadata(xml, options)

  xml.target!
end
build_reference_request(money, reference, options) click to toggle source
# File lib/active_merchant/billing/gateways/nab_transact.rb, line 116
def build_reference_request(money, reference, options)
  xml = Builder::XmlMarkup.new

  transaction_id, order_id, preauth_id, original_amount = reference.split('*')

  xml.tag! 'amount', (money ? amount(money) : original_amount)
  xml.tag! 'currency', options[:currency] || currency(money)
  xml.tag! 'txnID', transaction_id
  xml.tag! 'purchaseOrderNo', order_id
  xml.tag! 'preauthID', preauth_id

  add_metadata(xml, options)

  xml.target!
end
build_request(action, body) click to toggle source

Generate payment request XML

- API is set to allow multiple Txn's but currently only allows one
- txnSource = 23 - (XML)
# File lib/active_merchant/billing/gateways/nab_transact.rb, line 135
def build_request(action, body)
  xml = Builder::XmlMarkup.new
  xml.instruct!
  xml.tag! 'NABTransactMessage' do
    xml.tag! 'MessageInfo' do
      xml.tag! 'messageID', SecureRandom.hex(15)
      xml.tag! 'messageTimestamp', generate_timestamp
      xml.tag! 'timeoutValue', request_timeout
      xml.tag! 'apiVersion', API_VERSION
    end

    xml.tag! 'MerchantInfo' do
      xml.tag! 'merchantID', @options[:login]
      xml.tag! 'password', @options[:password]
    end

    xml.tag! 'RequestType', 'Payment'
    xml.tag! 'Payment' do
      xml.tag! 'TxnList', "count" => 1 do
        xml.tag! 'Txn', "ID" => 1 do
          xml.tag! 'txnType', TRANSACTIONS[action]
          xml.tag! 'txnSource', 23
          xml << body
        end
      end
    end
  end

  xml.target!
end
commit(action, request) click to toggle source
# File lib/active_merchant/billing/gateways/nab_transact.rb, line 215
def commit(action, request)
  response = parse(ssl_post(test? ? self.test_url : self.live_url, build_request(action, request)))

  Response.new(success?(response), message_from(response), response,
    :test => test?,
    :authorization => authorization_from(response)
  )
end
commit_periodic(request) click to toggle source
# File lib/active_merchant/billing/gateways/nab_transact.rb, line 224
def commit_periodic(request)
  response = parse(ssl_post(test? ? self.test_periodic_url : self.live_periodic_url, build_periodic_request(request)))
  Response.new(success?(response), message_from(response), response,
    :test => test?,
    :authorization => authorization_from(response)
  )
end
expdate(credit_card) click to toggle source
# File lib/active_merchant/billing/gateways/nab_transact.rb, line 244
def expdate(credit_card)
  "#{format(credit_card.month, :two_digits)}/#{format(credit_card.year, :two_digits)}"
end
generate_timestamp() click to toggle source

YYYYDDMMHHNNSSKKK000sOOO

# File lib/active_merchant/billing/gateways/nab_transact.rb, line 269
def generate_timestamp
  time = Time.now.utc
  time.strftime("%Y%d%m%H%M%S#{time.usec}+000")
end
message_from(response) click to toggle source
# File lib/active_merchant/billing/gateways/nab_transact.rb, line 240
def message_from(response)
  response[:response_text] || response[:status_description]
end
parse(body) click to toggle source
# File lib/active_merchant/billing/gateways/nab_transact.rb, line 248
def parse(body)
  xml = REXML::Document.new(body)

  response = {}

  xml.root.elements.to_a.each do |node|
    parse_element(response, node)
  end

  response
end
parse_element(response, node) click to toggle source
# File lib/active_merchant/billing/gateways/nab_transact.rb, line 260
def parse_element(response, node)
  if node.has_elements?
    node.elements.each{|element| parse_element(response, element) }
  else
    response[node.name.underscore.to_sym] = node.text
  end
end
request_timeout() click to toggle source
# File lib/active_merchant/billing/gateways/nab_transact.rb, line 274
def request_timeout
  @options[:request_timeout] || 60
end
success?(response) click to toggle source
# File lib/active_merchant/billing/gateways/nab_transact.rb, line 232
def success?(response)
  SUCCESS_CODES.include?(response[:response_code])
end