spree_emerchantpay_genesis
Advanced tools
This is a Payment Module for Spree eCommerce that gives you the ability to process payments through emerchantpay's Payment Gateway - Genesis.
Add this line to your application's Gemfile:
gem 'spree_emerchantpay_genesis'
And then execute:
bundle
Or install it yourself as:
gem install spree_emerchantpay_genesis
Copy & run migrations
bundle exec rails g spree_emerchantpay_genesis:install
Restart your server
Spree::Gateway::EmerchantpayDirect or Spree:Gateway::EmerchantpayCheckoutSpree::Gateway::EmerchantpayDirect or Spree:Gateway::EmerchantpayCheckout payment method in the Configurationshostname used for the generation of the notification webhook. In most cases, the hostname should be the hostname of the Spree backend.return_success_url and return_failure_url. Those endpoints will be returned to the create_payment response
|:ORDER:| pattern in the URLs. The pattern will be replaced with the Spree Order Numbercurl --request 'POST' \
--url 'http://127.0.0.1:4000/api/v2/storefront/cart'
Response:
{
"data":{
"id":"59",
"type":"cart",
"attributes":{
"number":"R702094375",
...
"currency":"USD",
"state":"cart",
"token":"EsDjq1oXEgKI6kuujgfvFw1694531383712",
...
},
...
}
}
curl --request 'GET' \
--url 'https://demo.spreecommerce.org/api/v2/storefront/products' \
--header 'Accept: application/vnd.api+json'
curl --request 'POST' \
--url 'http://localhost:4000/api/v2/storefront/cart/add_item' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Spree-Order-Token: EsDjq1oXEgKI6kuujgfvFw1694531383712' \
--header 'Content-Type: application/vnd.api+json' \
--data '{
"variant_id": "130",
"quantity": "1"
}'
curl --request 'GET' \
--url 'https://demo.spreecommerce.org/api/v2/storefront/checkout/shipping_rates' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Spree-Order-Token: EsDjq1oXEgKI6kuujgfvFw1694531383712'
curl --request 'PATCH' \
--url 'http://localhost:4000/api/v2/storefront/checkout/select_shipping_method' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Spree-Order-Token: EsDjq1oXEgKI6kuujgfvFw1694531383712' \
--header 'Content-Type: application/vnd.api+json' \
--data '{
"shipping_method_id": "1"
}'
curl --request 'PATCH' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Spree-Order-Token: EsDjq1oXEgKI6kuujgfvFw1694531383712' \
--header 'Content-Type: application/vnd.api+json' \
--url 'http://localhost:4000/api/v2/storefront/checkout' \
--data '{
"order": {
"email": "john.smith@example.com",
"bill_address_attributes": {
"firstname": "John",
"lastname": "Smith",
"address1": "1 Area",
"city": "Louisville",
"phone": "01234567891",
"zipcode": "40202",
"country_iso": "US",
"state_id": 500
},
"ship_address_attributes": {
"firstname": "John",
"lastname": "Smith",
"address1": "1 Area",
"city": "Louisville",
"phone": "01234567891",
"zipcode": "40202",
"country_iso": "US",
"state_id": 500
},
"payments_attributes":[
{
"payment_method_id":"5"
}
]
},
"payment_source": {
"5": {
"name": "John Smith",
"number": "4200000000000000",
"month": 1,
"year": 2040,
"verification_value": "123",
"cc_type": "visa"
}
}
}'
CAUTION Create Payment endpoint will Complete the order! Call this endpoint in order to finish the order!
Accept Header, Java Enabled, Language, Color Depth, Screen height, Screen Width, Time Zone Offset, User Agent parameters must be retrieved from the customer browser. More info here.
curl --request 'POST' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Spree-Order-Token: EsDjq1oXEgKI6kuujgfvFw1694531383712' \
--header 'Content-Type: application/vnd.api+json' \
--url 'http://localhost:4000/api/v2/storefront/checkout/create_payment' \
--data '{
"payment_method_id": "5",
"source_attributes": {
"name": "John Smith",
"number": "4200000000000000",
"month": 1,
"year": 2040,
"verification_value": "123",
"cc_type": "visa",
"accept_header": "*/*",
"java_enabled": "true",
"language": "en-GB",
"color_depth": "32",
"screen_height": "400",
"screen_width": "400",
"time_zone_offset": "+0",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36"
}
}'
CAUTION If a redirect URL exists in the response object you MUST redirect the customer for payment completion. Check Response.
The Checkout Gateway doesn't require source_attributes by default (see p.4 Update Order). Upon Order Update or Payment Create the only required parameter is payment_method_id.
In some cases, the Gateway Web Payment Form may require Custom Attributes. Those attributes can be passed to the gateway via api/v2/storefront/checkout/create_payment.
public_metadata contains a list with custom attributes where the key is the transaction type chosen on the payment method configuration inside the administration backend.
curl --request 'POST' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Spree-Order-Token: EsDjq1oXEgKI6kuujgfvFw1694531383712' \
--header 'Content-Type: application/vnd.api+json' \
--url 'http://localhost:4000/api/v2/storefront/checkout/create_payment' \
--data '{
"payment_method_id": "8",
"source_attributes": {
"consumer_id":"123456",
"consumer_email": "travis@example.com",
"public_metadata": {
"sale3d": { "bin": "401200", "tail": "0085"},
"trustly_sale": {"return_success_url_target": "top"}
}
}
}'
Full list with the available Custom Attributes for every Transaction Type can be found here.
The payment can be finished and a request to the Gateway will be sent with one of the Order Next or Complete endpoints.
curl --request 'PATCH' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Spree-Order-Token: EsDjq1oXEgKI6kuujgfvFw1694531383712' \
--header 'Content-Type: application/vnd.api+json' \
--url 'http://localhost:4000/api/v2/storefront/checkout/complete'
In the JSON Response document you will find a redirect_url where the customer must be redirected for completing the payment. Check Response.
Create Payment response will contain emerchantpay_payment object. It will contain the current status of the payment.
Redirect URL will give you the next step.
States:
{
"data": {
"id": "XXX",
"type": "cart",
"attributes": {...},
"relationships": {...},
"emerchantpay_payment": {
"state": "pending_async",
"redirect_url": "<customer-redirect-url>"
}
}
}
CAUTION the following transaction actions must be executed via Spree Admin backend:
emerchantpay Direct Payment Method
emerchantpay Checkout Payment Method
Note: If you have trouble with your credentials or terminal configuration, get in touch with our support team
rake test
rake styles
bundle exec appraisal spree-4.4 rake test
bundle exec appraisal spree-master rake test
bundle exec appraisal install
Requires Docker Engine
RAILS_ENV=productiondocker compose up
RAILS_ENV=developmentPLUGIN_SOURCE=/<local path to the plugin source>docker compose -f compose.yaml -f development-compose.yaml up -d
pry (docker attach <container>).
Requires config.web_console.whitelisted_ips = '<host_ip>' inside the container (/mnt/spree/config/environments/development.rb)config.hosts.clear inside the container (/mnt/spree/config/environments/development.rb)The gem is available as open source under the terms of the MIT License.
FAQs
Unknown package
We found that spree_emerchantpay_genesis demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.