Integrate my Own Payment Gateway to Shift4Shop
Shift4Shop is pre-programmed with many payment gateways from the get-go. However, if a particular gateway that you want/need to use is not yet implemented, we have made it possible for that gateway's developers to create an integration on an ad hoc basis. The following instructions will allow you to add your gateway's Ad Hoc payment method to your Shift4Shop stores.
Integrating With An Ad Hoc Payment App
Before proceeding with the following steps, please make sure that your desired gateway's developer has created the REST API app for the gateway, and that they've provided you with the Public Key for the app as well as any credentials you will need to use their app. Once this is done, the following steps will let you add the payment method to your store.
Log into your Shift4Shop Online Store Manager.
Using the left navigation menu, go to Modules.
Once you get to the Modules page, use the search bar at the top and search for "REST API".
Click on the Settings button.
Here is the section where you will connect your store to the REST API app created by your payment gateway's developer. To continue:
5. Click on the Add button located at the top right.
6. Enter the REST API App's Public Key
(provided by your gateway's developer).
You will now be presented with a popup modal advising you of the permissions being used by the application.
7. Mark the acknowledgment checkbox to authorize the application
8. Click on the Authorize button at the bottom right of the modal.
The REST API Application is now added to your store. Make a note of the REST API application's name. In the next steps, you'll add the ad hoc payment module itself.
Enabling the Ad Hoc Payment Method
While still logged into your Shift4Shop Online Store Manager:
Use the left navigation menu and go to Settings > Payment.
At the Payments page, click on the Select Payment Methods button.
On the Payment Methods page, you will see a list of "Recommended Payment Solutions" listed at the top of the page. Directly below this section, you will see your installed payment modules.
3. Locate the Ad Hoc Payment method in that second section.
4. To the far right of it you will see an on/off switch. Click this to turn the module "On" and expand the settings for it.
5. Enter your Credentials in the provided sections.
(Again, the credentials will be provided by your gateway's developer)
6. Finally click Save at the top right of the page to enable the payment method.
The Ad Hoc Payment module is now available to your store.