class ActiveMerchant::Billing::PayJunctionGateway

PayJunction Gateway

This gateway accepts the following arguments:

:login    => your PayJunction username
:password => your PayJunction pass

Example use:

gateway = ActiveMerchant::Billing::Base.gateway(:pay_junction).new(
            :login => "my_account",
            :password => "my_pass"
         )

# set up credit card obj as in main ActiveMerchant example
creditcard = ActiveMerchant::Billing::CreditCard.new(
  :type       => 'visa',
  :number     => '4242424242424242',
  :month      => 8,
  :year       => 2009,
  :first_name => 'Bob',
  :last_name  => 'Bobsen'
)

# optionally specify address if using AVS
address = { :address1 => '101 Test Ave', :city => 'Test', :state => 'TS',
            :zip  => '10101', :country => 'US' }

# run request
response = gateway.purchase(1000, creditcard, :address => address) # charge 10 dollars

1) Check whether the transaction was successful

response.success?

2) Retrieve the message returned by PayJunction

response.message

3) Retrieve the unique transaction ID returned by PayJunction

response.authorization

This gateway supports “instant” transactions. These transactions allow you to execute an operation on a previously run card without card information provided you have the transaction id from a previous transaction with the same card. All functions that take a credit card object for this gateway can take a transaction id string instead.

Test Transactions

See the source for initialize() for test account information. Note that PayJunction does not allow test transactions on your account, so if the gateway is running in :test mode your transaction will be run against PayJunction’s global test account and will not show up in your account.

Transactions ran on this account go through a test processor, so there is no need to void or otherwise cancel transactions. However, for further safety, please use the special card numbers 4433221111223344 or 4444333322221111 and keep transaction amounts below $4.00 when testing.

Also note, transactions ran for an amount between $0.00 and $1.99 will likely result in denial. To demonstrate approvals, use amounts between $2.00 and $4.00.

Test transactions can be checked by logging into PayJunction Web Login with username ‘pj-cm-01’ and password ‘pj-cm-01p’

Usage Details

Below is a map of values accepted by PayJunction and how you should submit each to ActiveMerchant

PayJunction Field ActiveMerchant Use

dc_logon provide as :login value to gateway instantiation dc_password provide as :password value to gateway instantiation

dc_name will be retrieved from credit_card.name dc_first_name :first_name on CreditCard object instantiation dc_last_name :last_name on CreditCard object instantiation dc_number :number on CreditCard object instantiation dc_expiration_month :month on CreditCard object instantiation dc_expiration_year :year on CreditCard object instantiation dc_verification_number :verification_value on CC object instantiation

dc_transaction_amount include as argument to method for your transaction type dc_transaction_type do nothing, set by your transaction type dc_version do nothing, always “1.2”

dc_transaction_id submit as a string in place of CreditCard obj for

"instant" transactions.

dc_invoice :order_id in options for transaction method dc_notes :description in options for transaction method

See example use above for address AVS fields See recurring for periodic transaction fields

Constants

API_VERSION
DECLINE_CODES
FAILURE_MESSAGE
SUCCESS_CODES
SUCCESS_MESSAGE
TEST_LOGIN
TEST_PASSWORD

Public Class Methods

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

Public Instance Methods

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

The first half of the preauth(authorize)/postauth(capture) model. Checks to make sure funds are available for a transaction, and returns a transaction_id that can be used later to postauthorize (capture) the funds.

# File lib/active_merchant/billing/gateways/pay_junction.rb, line 166
def authorize(money, payment_source, options = {})
  parameters = {
    transaction_amount: amount(money)
  }

  add_payment_source(parameters, payment_source)
  add_address(parameters, options)
  add_optional_fields(parameters, options)
  commit('AUTHORIZATION', parameters)
end
capture(money, authorization, options = {}) click to toggle source

The second half of the preauth(authorize)/postauth(capture) model. Retrieve funds that have been previously authorized with authorization

# File lib/active_merchant/billing/gateways/pay_junction.rb, line 192
def capture(money, authorization, options = {})
  parameters = {
    transaction_id: authorization,
    posture: 'capture'
  }

  add_optional_fields(parameters, options)
  commit('update', parameters)
end
credit(money, authorization, options = {}) click to toggle source
# File lib/active_merchant/billing/gateways/pay_junction.rb, line 213
def credit(money, authorization, options = {})
  ActiveMerchant.deprecated CREDIT_DEPRECATION_MESSAGE
  refund(money, authorization, options)
end
purchase(money, payment_source, options = {}) click to toggle source

A simple sale, capturing funds immediately. Execute authorization and capture in a single step.

# File lib/active_merchant/billing/gateways/pay_junction.rb, line 179
def purchase(money, payment_source, options = {})
  parameters = {
    transaction_amount: amount(money)
  }

  add_payment_source(parameters, payment_source)
  add_address(parameters, options)
  add_optional_fields(parameters, options)
  commit('AUTHORIZATION_CAPTURE', parameters)
end
recurring(money, payment_source, options = {}) click to toggle source

Set up a sale that will be made on a regular basis for the same amount (ex. $20 a month for 12 months)

The parameter :periodicity should be specified as either :monthly, :weekly, or :daily The parameter :payments should be the number of payments to be made

gateway.recurring('2000', creditcard, :periodicity => :monthly, :payments => 12)

The optional parameter :starting_at takes a date or time argument or a string in YYYYMMDD format and can be used to specify when the first charge will be made. If omitted the first charge will be immediate.

# File lib/active_merchant/billing/gateways/pay_junction.rb, line 241
def recurring(money, payment_source, options = {})
  ActiveMerchant.deprecated RECURRING_DEPRECATION_MESSAGE

  requires!(options, %i[periodicity monthly weekly daily], :payments)

  periodic_type =
    case options[:periodicity]
    when :monthly
      'month'
    when :weekly
      'week'
    when :daily
      'day'
    end

  if options[:starting_at].nil?
    start_date = Time.now.strftime('%Y-%m-%d')
  elsif options[:starting_at].is_a?(String)
    sa = options[:starting_at]
    start_date = "#{sa[0..3]}-#{sa[4..5]}-#{sa[6..7]}"
  else
    start_date = options[:starting_at].strftime('%Y-%m-%d')
  end

  parameters = {
    transaction_amount: amount(money),
    schedule_periodic_type: periodic_type,
    schedule_create: 'true',
    schedule_limit: options[:payments].to_i > 1 ? options[:payments] : 1,
    schedule_periodic_number: 1,
    schedule_start: start_date
  }

  add_payment_source(parameters, payment_source)
  add_optional_fields(parameters, options)
  add_address(parameters, options)
  commit('AUTHORIZATION_CAPTURE', parameters)
end
refund(money, authorization, options = {}) click to toggle source

Return money to a card that was previously billed. authorization should be the transaction id of the transaction we are returning.

# File lib/active_merchant/billing/gateways/pay_junction.rb, line 204
def refund(money, authorization, options = {})
  parameters = {
    transaction_amount: amount(money),
    transaction_id: authorization
  }

  commit('CREDIT', parameters)
end
test?() click to toggle source
Calls superclass method ActiveMerchant::Billing::Gateway#test?
# File lib/active_merchant/billing/gateways/pay_junction.rb, line 280
def test?
  (test_login? || super)
end
void(authorization, options = {}) click to toggle source

Cancel a transaction that has been charged but has not yet made it through the batch process.

# File lib/active_merchant/billing/gateways/pay_junction.rb, line 220
def void(authorization, options = {})
  parameters = {
    transaction_id: authorization,
    posture: 'void'
  }

  add_optional_fields(parameters, options)
  commit('update', parameters)
end

Private Instance Methods

add_address(params, options) click to toggle source

add address fields if present

# File lib/active_merchant/billing/gateways/pay_junction.rb, line 318
def add_address(params, options)
  address = options[:billing_address] || options[:address]

  if address
    params[:address]   = address[:address1] unless address[:address1].blank?
    params[:city]      = address[:city]     unless address[:city].blank?
    params[:state]     = address[:state]    unless address[:state].blank?
    params[:zipcode]   = address[:zip]      unless address[:zip].blank?
    params[:country]   = address[:country]  unless address[:country].blank?
  end
end
add_billing_id(params, billingid) click to toggle source

add field for “instant” transaction, using previous transaction id

# File lib/active_merchant/billing/gateways/pay_junction.rb, line 313
def add_billing_id(params, billingid)
  params[:transaction_id] = billingid
end
add_creditcard(params, creditcard) click to toggle source

add fields for credit card

# File lib/active_merchant/billing/gateways/pay_junction.rb, line 300
def add_creditcard(params, creditcard)
  if creditcard.respond_to?(:track_data) && creditcard.track_data.present?
    params[:track] = creditcard.track_data
  else
    params[:name]                 = creditcard.name
    params[:number]               = creditcard.number
    params[:expiration_month]     = creditcard.month
    params[:expiration_year]      = creditcard.year
    params[:verification_number]  = creditcard.verification_value if creditcard.verification_value?
  end
end
add_optional_fields(params, options) click to toggle source
# File lib/active_merchant/billing/gateways/pay_junction.rb, line 330
def add_optional_fields(params, options)
  params[:notes] = options[:description] unless options[:description].blank?
  params[:invoice] = options[:order_id].to_s.gsub(/[^-\/\w.,']/, '') unless options[:order_id].blank?
end
add_payment_source(params, source) click to toggle source

add fields depending on payment source selected (cc or transaction id)

# File lib/active_merchant/billing/gateways/pay_junction.rb, line 291
def add_payment_source(params, source)
  if source.is_a?(String)
    add_billing_id(params, source)
  else
    add_creditcard(params, source)
  end
end
commit(action, parameters) click to toggle source
# File lib/active_merchant/billing/gateways/pay_junction.rb, line 335
def commit(action, parameters)
  url = test? ? self.test_url : self.live_url

  response = parse(ssl_post(url, post_data(action, parameters)))

  Response.new(
    successful?(response),
    message_from(response),
    response,
    test: test?,
    authorization: response[:transaction_id] || parameters[:transaction_id]
  )
end
message_from(response) click to toggle source
# File lib/active_merchant/billing/gateways/pay_junction.rb, line 353
def message_from(response)
  if successful?(response)
    SUCCESS_MESSAGE
  else
    DECLINE_CODES[response[:response_code]] || FAILURE_MESSAGE
  end
end
parse(body) click to toggle source
# File lib/active_merchant/billing/gateways/pay_junction.rb, line 376
def parse(body)
  # PayJunction uses the Field Separator ASCII character to separate key/val
  # pairs in the response. The <FS> character's octal value is 034.
  #
  # Sample response:
  #
  # transaction_id=44752<FS>response_code=M4<FS>response_message=Declined (INV TEST CARD).

  pairs = body.chomp.split("\034")
  response = {}
  pairs.each do |pair|
    key, val = pair.split('=')
    response[key[3..-1].to_sym] = val ? normalize(val) : nil
  end
  response
end
post_data(action, params) click to toggle source
# File lib/active_merchant/billing/gateways/pay_junction.rb, line 361
def post_data(action, params)
  if test?
    # test requests must use global test account
    params[:logon]      = TEST_LOGIN
    params[:password]   = TEST_PASSWORD
  else
    params[:logon]      = @options[:login]
    params[:password]   = @options[:password]
  end
  params[:version] = API_VERSION
  params[:transaction_type] = action

  params.reject { |_k, v| v.blank? }.collect { |k, v| "dc_#{k}=#{CGI.escape(v.to_s)}" }.join('&')
end
successful?(response) click to toggle source
# File lib/active_merchant/billing/gateways/pay_junction.rb, line 349
def successful?(response)
  SUCCESS_CODES.include?(response[:response_code]) || response[:query_status] == true
end
test_login?() click to toggle source
# File lib/active_merchant/billing/gateways/pay_junction.rb, line 286
def test_login?
  @options[:login] == TEST_LOGIN && @options[:password] == TEST_PASSWORD
end