Class: ActiveMerchant::Billing::PayJunctionGateway

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

Overview

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 instantation 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 instantation dc_last_name :last_name on CreditCard object instantation dc_number :number on CreditCard object instantation dc_expiration_month :month on CreditCard object instantation dc_expiration_year :year on CreditCard object instantation dc_verification_number :verification_value on CC object instantation

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

Constant Summary collapse

API_VERSION = 
'1.2'
TEST_LOGIN = 
'pj-ql-01'
TEST_PASSWORD = 
'pj-ql-01p'
SUCCESS_CODES = 
["00", "85"]
SUCCESS_MESSAGE = 
'The transaction was approved.'
FAILURE_MESSAGE = 
'The transaction was declined.'
DECLINE_CODES = 
{
  "AE"  => 'Address verification failed because address did not match.',
  'ZE'  => 'Address verification failed because zip did not match.',
  'XE'  => 'Address verification failed because zip and address did not match.',
  'YE'  => 'Address verification failed because zip and address did not match.',
  'OE'  => 'Address verification failed because address or zip did not match.',
  'UE'  => 'Address verification failed because cardholder address unavailable.',
  'RE'  => 'Address verification failed because address verification system is not working.',
  'SE'  => 'Address verification failed because address verification system is unavailable.',
  'EE'  => 'Address verification failed because transaction is not a mail or phone order.',
  'GE'  => 'Address verification failed because international support is unavailable.',
  'CE'  => 'Declined because CVV2/CVC2 code did not match.',
  '04'  => 'Declined. Pick up card.',
  '07'  => 'Declined. Pick up card (Special Condition).',
  '41'  => 'Declined. Pick up card (Lost).',
  '43'  => 'Declined. Pick up card (Stolen).',
  '13'  => 'Declined because of the amount is invalid.',
  '14'  => 'Declined because the card number is invalid.',
  '80'  => 'Declined because of an invalid date.',
  '05'  => 'Declined. Do not honor.',
  '51'  => 'Declined because of insufficient funds.',
  'N4'  => 'Declined because the amount exceeds issuer withdrawal limit.',
  '61'  => 'Declined because the amount exceeds withdrawal limit.',
  '62'  => 'Declined because of an invalid service code (restricted).',
  '65'  => 'Declined because the card activity limit exceeded.',
  '93'  => 'Declined because there a violation (the transaction could not be completed).',
  '06'  => 'Declined because address verification failed.',
  '54'  => 'Declined because the card has expired.',
  '15'  => 'Declined because there is no such issuer.',
  '96'  => 'Declined because of a system error.',
  'N7'  => 'Declined because of a CVV2/CVC2 mismatch.',
  'M4'  => 'Declined.', 
  "FE"  => "There was a format error with your Trinity Gateway Service (API) request.",
  "LE"  => "Could not log you in (problem with dc_logon and/or dc_password).",
  'NL'  => 'Aborted because of a system error, please try again later. ',
  'AB'  => 'Aborted because of an upstream system error, please try again later.'
}

Constants inherited from Gateway

Gateway::DEBIT_CARDS

Constants included from PostsData

PostsData::MAX_RETRIES, PostsData::OPEN_TIMEOUT, PostsData::READ_TIMEOUT

Instance Attribute Summary

Attributes inherited from Gateway

#options

Instance Method Summary collapse

Methods inherited from Gateway

#card_brand, card_brand, inherited, supports?

Methods included from Utils

generate_unique_id

Methods included from CreditCardFormatting

#format

Methods included from RequiresParameters

#requires!

Methods included from PostsData

included, #retry_exceptions, #ssl_post

Constructor Details

#initialize(options = {}) ⇒ PayJunctionGateway

Returns a new instance of PayJunctionGateway.



158
159
160
161
162
 
# File 'lib/active_merchant/billing/gateways/pay_junction.rb', line 158

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

Instance Method Details

#authorize(money, payment_source, options = {}) ⇒ Object

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.



167
168
169
170
171
172
173
174
175
176
 
# File 'lib/active_merchant/billing/gateways/pay_junction.rb', line 167

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 = {}) ⇒ Object

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



193
194
195
196
197
198
199
200
201
 
# File 'lib/active_merchant/billing/gateways/pay_junction.rb', line 193

def capture(money, authorization, options = {})
  parameters = {
    :transaction_id => authorization,
    :posture => 'capture'
  }
  
  add_optional_fields(parameters, options)                                          
  commit('update', parameters)
end

#credit(money, authorization, options = {}) ⇒ Object

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



205
206
207
208
209
210
211
212
 
# File 'lib/active_merchant/billing/gateways/pay_junction.rb', line 205

def credit(money, authorization, options = {})  
  parameters = {
    :transaction_amount => amount(money),
    :transaction_id => authorization
  }
                                            
  commit('CREDIT', parameters)
end

#purchase(money, payment_source, options = {}) ⇒ Object

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



180
181
182
183
184
185
186
187
188
189
 
# File 'lib/active_merchant/billing/gateways/pay_junction.rb', line 180

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 = {}) ⇒ Object

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.



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/active_merchant/billing/gateways/pay_junction.rb', line 237

def recurring(money, payment_source, options = {})        
  requires!(options, [: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

#test? ⇒ Boolean

Returns:

  • (Boolean) 


273
274
275
 
# File 'lib/active_merchant/billing/gateways/pay_junction.rb', line 273

def test?
  test_login? || @options[:test] || super
end

#void(money, authorization, options = {}) ⇒ Object

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



216
217
218
219
220
221
222
223
224
 
# File 'lib/active_merchant/billing/gateways/pay_junction.rb', line 216

def void(money, authorization, options = {})
  parameters = {
    :transaction_id => authorization,
    :posture => 'void'
  }
  
  add_optional_fields(parameters, options)                                          
  commit('update', parameters)
end