Skip to content

Latest commit

 

History

History
89 lines (61 loc) · 3.78 KB

README.md

File metadata and controls

89 lines (61 loc) · 3.78 KB
Raw

PxPay Build Status

======= A Rubygem to integrate DPS-hosted payments through the Payment Express PxPay system.

Notice:

To integrate with the PxPay 2.0 you simply need to change the default URL to the new endpoint.

Pxpay::Base.pxpay_request_url = 'https://sec.paymentexpress.com/pxaccess/pxpay.aspx'

For self-hosted systems check out the amazing ActiveMerchant gem.

See http://www.paymentexpress.com/technical_resources/ecommerce_hosted/pxpay.html or http://www.paymentexpress.com/downloads/DPSECOM_PXPay.pdf for more details about PxPay.

Installation

Install from Rubygems

gem install pxpay

Then run rails generate pxpay:install to copy an initializer to your rails app. Make sure you add your own development credentials to the config/initializers/pxpay.rb file You can apply for a development account at https://www.paymentexpress.com/pxmi/apply

Usage

>> require 'nokogiri'
>> require 'pxpay'
>> request = Pxpay::Request.new( 1, 12.00, {:url_success => 'http://example.com/success/', :url_failure => 'http://example.com/failure'})
=> #<Pxpay::Request:0x00000101c9a840 >
>> request.url
=> "https://sec2.paymentexpress.com/pxpay/pxpay.aspx?userid=Fake_Dev&request=xxxxxxxxxx"

To send your customer to Payment Express for payment make a call to Pxpay::Request to request a redirection URL

def create
  request = Pxpay::Request.new( id , price, options )
  redirect_to request.url
end

Once your customer has entered their details Payment Express will redirect them back to the success URL that you provided.

Use Pxpay:Response to get the transaction details back from Payment Express.

def success
  response = Pxpay::Response.new(params).response
  hash = response.to_hash
  ## Do something with the results hash
end

N.B. There is a minor caveat here: Payment Express includes a system called fail-proof result notification where as soon as the customer has finished the transaction they will send a background request.

This means your success/failure URL will be hit at least twice for each transaction, so you must allow for this in your code. See http://www.paymentexpress.com/technical_resources/ecommerce_hosted/pxpay.html#ResultNotification for details.

Token Billing can be implemented by setting :token_billing => true inside the Request option hash.

N.B.

The source of most non-gem related errors comes from the fact that Payment Express caches the details of a transaction with the ID given. If you are having problems with the wrong price being charged or an invalid card type error make sure you are sending a unique ID through with each transaction.

This gem is in no way endorsed or affiliated with Payment Express

TODO

  • Add ability to set global configuration options
  • Add more tests

Contributing to PxPay

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
  • Fork the project
  • Start a feature/bugfix branch
  • Commit and push until you are happy with your contribution
  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright

Copyright (c) 2012 Bradley Priest. See LICENSE.txt for further details.