3. Setup and Configuration

This page describes the steps required to configure the VPay WooCommerce plugin for quick use.

  1. Go to WooCommerce > Settings and click on the Payments tab.

  2. You should see VPay listed along with your other payment methods. Click Set Up.

  3. On the next screen, configure the plugin. There is a selection of options on the screen. See descriptions for each one below.

    • Enable/Disable - Tick this checkbox to Enable VPay on your store's checkout.

    • Webhook Authentication Token - Tick the option to enable Webhook Authentication Token. NOTE: Copy the webhook URL provided and paste it into the Webhook input field on the VPay Dashboard. Save the changes.

    • Title - Enter a caption for what your users see during checkout.

    • Description - Provide a message that appears under the payment fields on the checkout page, explaining VPay and the available payment methods..

    • Test Mode - Check this box to enable test mode. This allows you to test payments using SANDBOX details before going LIVE. Uncheck it when your store is ready to accept real payments.

    • Transaction_Charge - Specify the amount to be charged to the paying customer in addition to the order amount. This amount must be greater than 0 and shares the currency of the order amount.

    • Transaction_Charge_Type - Either flat or percentage. This indicates how the payment total should be computed using the order amount and txn_charge above. E.g. order amount = 1000, txn_charge = 5, txn_charge_type = “percentage” then total = 1000 + (1000 * 5%) = 1000 + 50 = 1050.

    • API Keys - The next two text boxes are for your VPay API keys, which you can get from your VPay Dashboard. If you are in Test Mode in step four, then use your VPay SANDBOX API keys here. Otherwise, you can enter your VPay LIVE keys.

    • Click on Save Changes to update the settings.

That simple!

We strongly recommend that you set a Webhook URL on your VPay dashboard. This way, whenever a transaction is complete on your store, we'll send a notification to the Webhook URL, which will update the order and mark it as paid. You can set this up by using the URL in red at the top of the Settings page. Just copy the URL and save it as your webhook URL on your VPay dashboard under Settings > Webhooks tab. If you do not find VPay on the Payment method options, please go through the settings again and ensure that:

  1. You've checked the "Enable/Disable" checkbox

  2. You've entered your API Keys in the appropriate field

  3. You've clicked on Save Changes during setup

Last updated