Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
samples
spec
.gitignore
.travis.yml
ChangeLog.txt
Gemfile
LICENSE.txt
README.md
Rakefile
paypal-sdk-merchant.gemspec

README.md

Merchant

The PayPal Merchant SDK provides Ruby APIs for processing payments, recurring payments, subscriptions and transactions using PayPal's Merchant APIs, which include Express Checkout, Recurring Payments, Direct Payment and Transactional APIs.

Installation

Add this line to your application's Gemfile:

gem 'paypal-sdk-merchant'

And then execute:

$ bundle

Or install it yourself as:

$ gem install paypal-sdk-merchant

Configuration

For Rails application:

rails g paypal:sdk:install

For other ruby application, create a configuration file(config/paypal.yml):

development: &default
  username: jb-us-seller_api1.paypal.com
  password: WX4WTU3S8MY44S7F
  signature: AFcWxV21C7fd0v3bYYYRCpSSRl31A7yDhhsPUU2XhtMoZXsWHFxu-RWy
  app_id: APP-80W284485P519543T
  http_timeout: 30
  mode: sandbox
  # # with certificate
  # cert_path: "config/cert_key.pem"
  # # with token authentication
  # token: ESTy2hio5WJQo1iixkH29I53RJxaS0Gvno1A6.YQXZgktxbY4I2Tdg
  # token_secret: ZKPhUYuwJwYsfWdzorozWO2U9pI
  # # with Proxy
  # http_proxy: http://proxy-ipaddress:3129/
test:
  <<: *default
production:
  <<: *default
  mode: live

Load Configurations from specified file:

PayPal::SDK::Core::Config.load('config/paypal.yml',  ENV['RACK_ENV'] || 'development')

Create API object

Create API object:

api = PayPal::SDK::Merchant::API.new

Override configuration while creating a object:

api = PayPal::SDK::Merchant::API.new(:development)
api = PayPal::SDK::Merchant::API.new(:development, :app_id => "XYZ")
api = PayPal::SDK::Merchant::API.new(:app_id => "XYZ")    # Take default environment.

Change configuration:

api.set_config :testing
api.set_config :testing, app_id => "XYZ"

Build Request Object

To make api request, we need to build a request object.

# To build a empty request object
transaction_search_request = api.build_transaction_search()

# To build a request object with default data
transaction_search_request = api.build_transaction_search( :StartDate => "2012-11-11T11:30:00+00:00", :EndDate => "2012-11-11T11:31:00+00:00" )

The Build method can be access with camelcase or underscore:

api = api.build_transaction_search()
# (or)
api = api.BuildTransactionSearch()

Assign value to members

Members can be access with camelcase or underscore format.

transaction_search_request.StartDate = "2012-11-11T11:30:00+00:00"
# With underscore
transaction_search_request.start_date = "2012-11-11T11:30:00+00:00"

To Get members list for the given object( For Reference ):

transaction_search_request.members

Make API Request

Make api call with request object:

transaction_search_response = api.transaction_search(transaction_search_request)

Make api call with hash:

transaction_search_response = api.transaction_search( :StartDate => "2012-11-11T11:30:00+00:00", :EndDate => "2012-11-11T11:31:00+00:00" )

Access values from response object

To get response status:

transaction_search_response.ack

Example

require 'paypal-sdk-merchant'
@api = PayPal::SDK::Merchant::API.new(
  :mode      => "sandbox",  # Set "live" for production
  :app_id    => "APP-80W284485P519543T",
  :username  => "jb-us-seller_api1.paypal.com",
  :password  => "WX4WTU3S8MY44S7F",
  :signature => "AFcWxV21C7fd0v3bYYYRCpSSRl31A7yDhhsPUU2XhtMoZXsWHFxu-RWy" )

# Build request object
@do_direct_payment = @api.build_do_direct_payment({
  :DoDirectPaymentRequestDetails => {
    :PaymentAction => "Sale",
    :PaymentDetails => {
      :OrderTotal => {
        :currencyID => "USD",
        :value => "1" },
      :NotifyURL => "http://localhost:3000/samples/merchant/ipn_notify" },
    :CreditCard => {
      :CreditCardType => "Visa",
      :CreditCardNumber => "4904202183894535",
      :ExpMonth => 12,
      :ExpYear => 2022,
      :CVV2 => "962" } } })

# Make API call & get response
@do_direct_payment_response = @api.do_direct_payment(@do_direct_payment)

# Access Response
@do_direct_payment_response.Ack
@do_direct_payment_response.TransactionID

Samples

Add following line in rails Gemfile:

gem 'paypal-sdk-merchant'
gem 'merchant_samples', :git => "https://github.com/paypal/merchant-sdk-ruby.git", :group => :development

Configure routes(config/routes.rb):

mount MerchantSamples::Engine => "/samples" if Rails.env.development?

To get default paypal configuration execute:

rails g paypal:sdk:install

Run rails server and check the samples.

Something went wrong with that request. Please try again.