forked from activemerchant/active_merchant
/
README
135 lines (104 loc) · 5.54 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
= Active Merchant
This library is supposed to aid in creating e-commerce software in Ruby.
In the future we want to support all "good" payment gateways.
This library is the foundation of commerce for http://www.shopify.com.
Please visit the {ActiveMerchant homepage}[http://activemerchant.org] for more resources, tutorials and other information about this project.
== Supported Direct Payment Gateways
The {ActiveMerchant Wiki}[http://github.com/Shopify/active_merchant/wikis] contains a {table of features supported by each gateway}[http://github.com/Shopify/active_merchant/wikis/gatewayfeaturematrix].
* {Authorize.Net CIM}[http://www.authorize.net/] - US
* {Authorize.Net}[http://www.authorize.net/] - US
* {Beanstream.com}[http://www.beanstream.com/] - CA
* {Braintree}[http://www.braintreepaymentsolutions.com] - US
* {CardStream}[http://www.cardstream.com/] - GB
* {CyberSource}[http://www.cybersource.com] - US
* {DataCash}[http://www.datacash.com/] - GB
* {Efsnet}[http://www.concordefsnet.com/] - US
* {eWAY}[http://www.eway.com.au/] - AU
* {E-xact}[http://www.e-xact.com] - CA, US
* {LinkPoint}[http://www.linkpoint.com/] - US
* {Merchant e-Solutions}[http://merchante-solutions.com/] - US
* {Modern Payments}[http://www.modpay.com] - US
* {Moneris}[http://www.moneris.com/] - CA
* {NetRegistry}[http://www.netregistry.com.au] - AU
* {NETbilling}[http://www.netbilling.com] - US
* {PayJunction}[http://www.payjunction.com/] - US
* {PaySecure}[http://www.commsecure.com.au/paysecure.shtml] - AU
* {PayPal Express Checkout}[https://www.paypal.com/cgi-bin/webscr?cmd=xpt/merchant/ExpressCheckoutIntro-outside] - US, CA, SG, AU
* {PayPal Payflow Pro}[https://www.paypal.com/cgi-bin/webscr?cmd=_payflow-pro-overview-outside] - US, CA, SG, AU
* {PayPal Website Payments Pro (UK)}[https://www.paypal.com/uk/cgi-bin/webscr?cmd=_wp-pro-overview-outside] - GB
* {PaymentExpress}[http://www.paymentexpress.com/] - AU, MY, NZ, SG, ZA, GB, US
* {PayPal Website Payments Pro (CA)}[https://www.paypal.com/cgi-bin/webscr?cmd=_wp-pro-overview-outside] - CA
* {PayPal Express Checkout}[https://www.paypal.com/cgi-bin/webscr?cmd=xpt/merchant/ExpressCheckoutIntro-outside] - US
* {PayPal Website Payments Pro (US)}[https://www.paypal.com/cgi-bin/webscr?cmd=_wp-pro-overview-outside] - US
* {Plug'n Pay}[http://www.plugnpay.com/] - US
* {Protx}[http://www.protx.com] - GB
* {Psigate}[http://www.psigate.com/] - CA
* {PSL Payment Solutions}[http://www.paymentsolutionsltd.com/] - GB
* {Quickpay}[http://quickpay.dk/] - DK
* {Realex}[http://www.realexpayments.com/] - IE, GB
* {Sage Payment Solutions}[http://www.sagepayments.com] - US, CA
* {Sallie Mae}[http://www.salliemae.com] - US
* {SecurePay}[http://securepay.com.au] - AU
* {SecurePay}[http://www.securepay.com/] - US
* {SecurePayTech}[http://www.securepaytech.com/] - NZ
* {SkipJack}[http://www.skipjack.com/] - US, CA
* {TransFirst}[http://www.transfirst.com/] - US
* {TrustCommerce}[http://www.trustcommerce.com/] - US
* {USA ePay}[http://www.usaepay.com/] - US
* {Verifi}[http://www.verifi.com/] - US
* {ViaKLIX}[http://viaklix.com] - US
* {Wirecard}[http://www.wirecard.com] - DE
== Supported Offsite Payment Gateways
* {PayPal Website Payments Standard}[https://www.paypal.com/cgi-bin/webscr?cmd=_wp-standard-overview-outside]
* Chronopay[http://www.chronopay.com]
* Nochex[http://www.nochex.com]
* {Banca Sella GestPay}[https://www.sella.it/banca/ecommerce/gestpay/gestpay.jsp]
* {2 Checkout}[http://www.2checkout.com]
* {HiTRUST}[http://www.hitrust.com.hk/]
== Download
Currently this library is available with git from:
git://github.com/Shopify/active_merchant.git
== Installation
=== From Git
You can check out the latest source from git:
> git pull git://github.com/Shopify/active_merchant.git
=== As a Rails plugin
ActiveMerchant includes an init.rb file. This means that Rails will automatically load ActiveMerchant on startup. Run the following command from the root directory of your Rails project to install ActiveMerchant as a Rails plugin:
> ./script/plugin install git://github.com/Shopify/active_merchant.git
=== From Ruby Gems
Installation from RubyGems
> gem install activemerchant
== Sample Usage
require 'rubygems'
require 'active_merchant'
# Use the TrustCommerce test servers
ActiveMerchant::Billing::Base.mode = :test
# ActiveMerchant accepts all amounts as Integer values in cents
# $10.00
amount = 1000
# The card verification value is also known as CVV2, CVC2, or CID
credit_card = ActiveMerchant::Billing::CreditCard.new(
:first_name => 'Bob',
:last_name => 'Bobsen',
:number => '4242424242424242',
:month => '8',
:year => '2012',
:verification_value => '123'
)
# Validating the card automatically detects the card type
if credit_card.valid?
# Create a gateway object for the TrustCommerce service
gateway = ActiveMerchant::Billing::TrustCommerceGateway.new(
:login => 'TestMerchant',
:password => 'password'
)
# Authorize for the amount
response = gateway.purchase(amount, credit_card)
if response.success?
puts "Successfully charged $#{sprintf("%.2f", amount / 100)} to the credit card #{credit_card.display_number}"
else
raise StandardError, response.message
end
end
== Contributing
Please see the {ActiveMerchant Guide to Contributing}[http://github.com/Shopify/active_merchant/wikis/contributing] for information on adding a new gateway to ActiveMerchant.