Skip to content

Latest commit

 

History

History
171 lines (136 loc) · 6.58 KB

README.rdoc

File metadata and controls

171 lines (136 loc) · 6.58 KB
Raw

# Authorize.Net Ruby SDK

‘gem install authorizenet`

## Prerequisites

  • Ruby 1.9.3 or higher

  • RubyGem 1.3.7 or higher (to build the gem)

  • RDoc 1.0 or higher (to build documentation)

  • Rake 0.8.7 or higher (to use the rake tasks)

  • Bundle 1.6 or higher

  • RSpec 2.1 or higher (to run rspec tests)

## Installation from rubygems.org

““

> sudo gem install authorizenet

““ ##

# Installation from project

““

> bundle install
> rake gem
> sudo gem install ./authorizenet-1.8.2.gem

““ ## Registration & Configuration

Get a sandbox account at developer.authorize.net/sandbox/ To run rspec tests, create a spec/credentials.yml with the following keys and the values obtained as described below. ““ #obtain an API login_id and transaction_id according to instructions at developer.authorize.net/faqs/#gettranskey api_transaction_key: {transaction_key_value} api_login_id: {login_id_value} #obtained md5 hash value by first setting the hash value in sandbox.authorize.net/ under the Account tab->MD5 Hash md5_value: {md5_value} ““ To get spec/reporting_spec.rb to pass, go to sandbox.authorize.net/ under Account tab->Transaction Details API and enable it. ## Usage

### XML Api Integration ““ruby

require 'authorizenet'

include AuthorizeNet::API

transaction = Transaction.new('API_LOGIN', 'API_KEY', :gateway => :sandbox)
request = CreateTransactionRequest.new
request.transactionRequest = TransactionRequestType.new
request.transactionRequest.amount = 39.55

request.transactionRequest.payment = PaymentType.new
request.transactionRequest.payment.creditCard = CreditCardType.new('4111111111111111','0515') 

request.transactionRequest.transactionType = TransactionTypeEnum::AuthCaptureTransaction

response = transaction.create_transaction(request)

if response.messages.resultCode == MessageTypeEnum::Ok
  puts "Successfully made a purchase (authorization code: #{response.transactionResponse.authCode})"
else
  raise "Failed to make purchase."
end

““

### Advanced Merchant Integration (AIM)

““ruby

require 'rubygems'
require 'authorizenet'

transaction = AuthorizeNet::AIM::Transaction.new('API_LOGIN', 'API_KEY', :gateway => :sandbox)
credit_card = AuthorizeNet::CreditCard.new('4111111111111111', '1120')
response = transaction.purchase('10.00', credit_card)

if response.success?
  puts "Successfully made a purchase (authorization code: #{response.authorization_code})"
else
  raise "Failed to make purchase."
end

““

### Direct Post Method (DPM)

A generator is provided to aid in setting up a Direct Post Method application. In the example below payments is the name of the controller to generate. ““

> sudo gem install rails -v '>= 3.2'
> sudo gem install authorizenet
> rails new my_direct_post_app
> cd my_direct_post_app
> edit Gemfile and add the line "gem 'authorizenet'"
> rails g authorize_net:direct_post payments YOUR_API_LOGIN_ID YOUR_TRANSACTION_KEY MERCH_HASH_KEY
> rails server

““

After running the generator you will probably want to customize the payment form found in app/views/payments/payment.erb and the receipt found in app/views/payments/receipt.erb.

There is also a default layout generated, app/views/layouts/authorize_net.erb. If you already have your own layout, you can delete that file and the reference to it in the controller (app/controllers/payments_controller.rb).

### Server Integration Method (SIM)

A generator is provided to aid in setting up a Server Integration Method application. In the example below payments is the name of the controller to generate. ““

> sudo gem install rails -v '>= 3.2'
> sudo gem install authorizenet
> rails new my_sim_app
> cd my_sim_app
> rails g authorize:sim payments YOUR_API_LOGIN_ID YOUR_TRANSACTION_KEY MERCH_HASH_KEY
> rails server

““ After running the generator you will probably want to customize the payment page found in app/views/payments/payment.erb and the thank you page found in app/views/payments/thank_you.erb.

You may also want to customize the actual payment form and receipt pages. That can be done by making the necessary changes to the AuthorizeNet::SIM::Transaction object (@sim_transaction) found in the payment action in app/controllers/payments_controller.rb. The styling of those hosted pages are controlled by the AuthorizeNet::SIM::HostedReceiptPage and AuthorizeNet::SIM::HostedPaymentForm objects (which are passed to the AuthorizeNet::SIM::Transaction).

There is also a default layout generated, app/views/layouts/authorize_net.erb. If you already have your own layout, you can delete that file and the reference to it in the controller (app/controllers/payments_controller.rb).

### Automated Recurring Billing (ARB) ““ruby

require 'rubygems'
require 'authorizenet'

transaction = AuthorizeNet::ARB::Transaction.new('API_LOGIN', 'API_KEY', :gateway => :sandbox)
subscription = AuthorizeNet::ARB::Subscription.new(
  :name => "Monthly Gift Basket",
  :length => 1,
  :unit => :month,
  :start_date => Date.today,
  :total_occurrences => :unlimited,
  :amount => 100.00,
  :invoice_number => '1234567',
  :description => "John Doe's Monthly Gift Basket",
  :credit_card => AuthorizeNet::CreditCard.new('4111111111111111', '1120'),
  :billing_address => AuthorizeNet::Address.new(:first_name => 'John', :last_name => 'Doe')
)
response = transaction.create(subscription)

if response.success?
  puts "Successfully created a subscription (subscription id: #{response.subscription_id})"
else
  raise "Failed to create a subscription."
end

““ ### Card Present (CP) ““ruby

require 'rubygems'
require 'authorizenet'

transaction = AuthorizeNet::AIM::Transaction.new('API_LOGIN', 'API_KEY', :gateway => :card_present_sandbox)
credit_card = AuthorizeNet::CreditCard.new(nil, nil, :track_1 => '%B4111111111111111^DOE/JOHN^1803101000000000020000831000000?')
response = transaction.purchase('10.00', credit_card)

if response.success?
  puts "Successfully made a purchase (authorization code: #{response.authorization_code})"
else
  raise "Failed to make purchase."
end

““ ## Credit Card Test Numbers

For your reference, you can use the following test credit card numbers. The expiration date must be set to the present date or later. Use 123 for the CCV code.

  • American Express: 370000000000002

  • Discover: 6011000000000012

  • Visa: 4007000000027

  • JCB: 3088000000000017

  • Diners Club/ Carte Blanche: 38000000000006

  • Visa (Card Present Track 1): %B4111111111111111^DOE/JOHN^1803101000000000020000831000000?