Basic Configuration - Publishable Key API Configuration

Basic Configuration - Publishable Key API Configuration

Module Configuration

Before you start configuring anything, please take note of the mode that you are in (Test Mode or Live Mode). There is a toggle to show Test Data. Please ensure that if you are configuring for the Live Environment, that the toggle is not set to "Test mode" so that you copy Live Keys and configurations - Likewise with Test Environment with Test Data, ensure you have "Test mode" set to Yes. See below the flags to check.




Once you are ready to configure Stripe with Omnyfy, start by obtaining the API keys. In Stripe, go to the top right menu and choose Developers. Then on the left menu, select  API keys. Here you will see 2 keys that will need to be copied: Publishable Key and Secret Key.


Payment Gateway

If you are not taking customer payments or Vendor payouts with Stripe and only using Stripe for Vendor Subscriptions Plans, you can skip this step and go to the next configuration step

Once you have copied the correct keys, in another tab/window, log in as an admin for the marketplace back end. Then go to Stores > Settings > Configuration > Sales > Payment Methods > Stripe > Configure > General Settings.

Field Name

Notes

Module Version

Dictates the version of the Stripe Payment module installed on the platform

Mode

Setting this will alter some of the behaviours of the payments.

Test: Purchases completed with a test card and not actually spend real money. You will also be able to test a variety of other example credit card scenarios.

Live: Will require real debit/credit cards to process an order and deals with real transactions. Only apply this when you are ready to launch your marketplace.

Publishable API Key

Copy and paste the token from your Stripe account

Secret API Key

Copy and paste the token from your Stripe account

Save Config at the top right once this has been input.



The webhooks will generate and link automatically in Stripe with the marketplace once this has been saved.

If you are not going to take payments for Vendor Subscription Plans, you can skip this step. Copy and paste the Publishable and Secret API Keys from the Stripe dashboard. Then in the Omnyfy admin, go to Stores > Settings > Configuration > Omnyfy > Stripe API (for subscription).




Field Name

Notes

Publishable API Key

Copy and paste the token from your Stripe account

Secret API Key

Copy and paste the token from your Stripe account

Debug

Allows Debug Mode enabled (for developer use)

Prorate

Leave as default "Yes"

Save Config once this is configured.

    • Related Articles

    • Basic Configuration - Google API Section

      Google API section Here you can configure a variety of different Google services. NOTE: If you are testing this on a staging environment (or an environment with HTTP Authorisation) the maps may be blocked from it unless you allow whitelisting. 1. ...

    • Basic Configuration - Theme Configuration

      Configuring the theme Ensure that you have already configured to use Smartwave Porto (or whichever you are using under the Content > Design > Configuration). You can revisit this from Step 3 - Basic Configuration - Setting the Theme. In our example, ...

    • Basic Configuration - Payment Gateway Additional API Endpoints

      Basic Webhook Configurations Ensure that you have already completed the webhook "Configure" field in step 2. This would have automatically created the webhook endpoint in Stripe with all of the events, however we do not need everything. In Stripe, go ...

    • Basic Configuration - Stripe Webhooks for Subscriptions

      Webhook Configurations for Subscriptions The subscription webhook is primarily used for vendor subscription plans that require payment. To find out how to set these up, please visit Creating a Subscription product in Stripe for Vendor Subscriptions. ...

    • Basic Configuration - Stripe Webhooks for Payouts

      Webhook Configurations for Payouts Next, you will be managing the endpoints from the Connect applications. In Stripe, go to Developers > Webhooks > Add Endpoint Here you will need to add the following: Endpoint URL Specific Events ...