Add this to your Gemfile (prefer the Github version over the RubyGem one for updates)
gem 'atos', :git => '[email protected]:gbarillot/atos.git'
then run bundle install
1.Create an Atos directory inside your /lib and drop the files given by your bank into it, so it should look like this :
/app
/config
...
/lib
/atos
/bin
request
request_2.4.18_2.96
...
/param
certif.fr.014295303911111
parmcom.014295303911111
parmcom.*
pathfile
2.To perform a payment, instanciate a request :
@request = Atos.new.request(
:merchant_id => '014295303911111',
:customer_id => 'YOUR_CUSTOMER_ID',
:amount => '1500',
:automatic_response_url => 'http://YOUR_SITE.com/ANY/LISTENING/URL/YOU/WANT',
:normal_return_url => 'http://YOUR_SITE.com/NORMAL/RETURN/URL',
:cancel_return_url => 'http://YOUR_SITE.com/CANCEL/URL'
)
3.You can now show the @request content in your view (it's an HTML form)
----- Let the customer pay on the bank platform, then listen to its response ----
4.Now, you can catch the DATA parameter in response by listening to the 'automatic_response_url' you gave above (not a tipo, DATA is upcase)
response = Atos.new.response(params[:DATA])
5.Finally, you get a hash in 'response', that follows the API specs :
{
:code
:error
:merchant_id
:merchant_country
:amount
:transaction_id
:payment_means
:transmission_date
:payment_time
:payment_date
:response_code
:payment_certificate
:authorisation_id
:currency_code
:card_number
:cvv_flag
:cvv_response_code
:bank_response_code
:complementary_code
:complementary_info
:return_context
:caddie
:receipt_complement
:merchant_language
:language
:customer_id
:order_id
:customer_email
:customer_ip_address
:capture_day
:capture_mode
:data
}
- The following parameters are required to perform a request :
(string) merchant_id
(string) customer_id
(string) amount
(string) automatic_response_url
(string) normal_return_url
(string) cancel_return_url
Above those required parameters, you can freely add any other parameter that follows the API specs (shopping cart, customer email, customer_ip_address...). Order and position in the hash doesn't matter at all.
- I prefer conventions over configuration, but you can also override with your own path dirs while instanciating the Atos class. You just add one step to the shortand way :
@request = Atos.new(
:root_path => '/where',
:request_path => '/where/ever',
:response_path => '/where/ever/you',
:pathfile_path => '/where/ever/you/want'
)
...And then...
@request.request(
:merchant_id => '014295303911111',
:amount => '1500',
:customer_id => YOUR_CUSTOMER_ID,
:automatic_response_url=>'http://YOUR_SITE.com/ANY/LISTENING/URL/YOU/WANT',
:normal_return_url => 'http://YOUR_SITE.com/NORMAL/FALLBACK/URL',
:cancel_return_url => 'http://YOUR_SITE.com/CANCEL/URL'
)
-
Default language is set to 'fr' and currency to 'Euro', simply pass your own 'locale/currency' in the request to override, as shown above.
-
Don't forget to check at the 'pathfile' Atos file, and fill requested paths according to your app absolute location on the server
-
Drop the credit card logos in a public dir, then fill this directory's absolute location on the server in the '/lib/atos/param/pathfile' file
-
The '014295303911111' merchant_id I use all the way here is the test merchant_id, obviously, use your own.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent