SpankPay

SpankPay SFCC Cartridge by SpankChain

The Salesforce Commerce Cloud SpankPay Cartridge is a lightweight Salesforce Reference App best-practice-following implementation of SpankChain's SpankPay blockchain-payment gateway.

SFRA version

This cartridge is built against SFCC SFRA version 4.4.1 and is guaranteed compatible with B2C Commerce API v18.10+

Installation

1. Clone this repository.

2. Modify package.json's paths: { base: {} } value to point to your local copy of the storefront-reference-architecture's app_storefront_base cartridge.

3. Run npm install to install all of the local dependencies (node version 11.15 recommended).

4. Run npm run compile:js from the command line to compile all client-side JS files. Run npm run compile:scss to do the same for CSS.

5. Upload the cartridges folder to the appropriate instance with the WebDAV client of your choice.

6. Add the plugin_spankpay cartridge to your cartridge path in Business Manager at: Administration > Sites > Manage Sites > {YOURSITE} - Settings.

7. Add the plugin_spankpay cartridge to your cartridge path in Business Manager at: Administration > Sites > Manage Sites > Business Manager - Settings.

8. Grant write permissions to the appropriate Business Manager user(s) for the new SpankPay Business Manager Extension by visiting: Administration > Organization > Roles, selecting the appropriate Role, switching to the "Business Manager Modules" tab, selecting the appropriate Site context(s), and scrolling down until you see the new SpankPay modules. This will append a new SpankPay submenu under the Business Manager's site's Merchant Tools

9. Navigate to Merchant Tools -> Ordering -> Payment Processors in Business Manager and create a new Payment Processor with ID: SPANKPAY and Description: SpankPay by SpankChain

10. Import payment-methods.xml from the ./metadata/ordering folder with Business Manager to install the custom SPANKPAY payment method.

11. Import system-and-custom-object-types.xml from the ./metadata/site/meta folder with Business Manager to install the custom SPANKPAY Site Preferences and spankPayAuth Custom Object type.

12. Navigate to the new SPANKPAY custom site preferences in Business Manager (Merchant Tools -> Site Preferences -> Custom Preferences -> SPANKPAY) and configure your private/public keys and other preferences. If you haven't yet signed up for a SpankPay Merchant account, now would be a good time!

13. SpankPay!

Template Overrides

Template overrides are minor, but may affect existing functionality. If any of these templates are also overridden by another cartridge, you will have to merge the changes from that cartridge with the changes made in the SpankPay version of the template. The recommended approach is to create a separate cartridge which contains only the merged templates.

cartridges/plugin_spankpay/cartridge/templates/default/checkout/billing/paymentOptions/paymentOptionsContent.isml cartridges/plugin_spankpay/cartridge/templates/default/checkout/billing/paymentOptions/paymentOptionsSummary.isml cartridges/plugin_spankpay/cartridge/templates/default/checkout/billing/paymentOptions/paymentOptionsTabs.isml cartridges/plugin_spankpay/cartridge/templates/default/checkout/billing/billing.isml cartridges/plugin_spankpay/cartridge/templates/default/checkout/billing/billingSummary.isml cartridges/plugin_spankpay/cartridge/templates/default/checkout/confirmation/confirmation.isml cartridges/plugin_spankpay/cartridge/templates/default/checkout/checkout.isml

Controller Overrides

No existent SFRA Controllers or Routes are extended or overridden by this Cartridge.