Skip to main content

Installation

Prerequisites​

  • WordPress 6.0+ (tested up to 6.7)
  • WooCommerce 3.0+ (tested up to 9.x)
  • PHP 7.4+
  • A VayaPin API key — generate one in the VayaPin dashboard under Developer → VayaCore → API Keys & BYOK (dashboard.vayapin.com/vayacore). The free Starter tier includes 50 conversions / month, no credit card required. See Get your API key for the steps.

1. Install the plugin​

You have three options.

  1. In WP admin go to Plugins → Add New.
  2. Search for VayaPin.
  3. Click Install Now → Activate.

Plugin install from WordPress.org

From a zip package​

  1. Go to Plugins → Add New → Upload Plugin.
  2. Pick the vayapin.zip we provided and click Install Now.
  3. Click Activate Plugin.

Manual SFTP​

  1. Upload the vayapin/ folder to /wp-content/plugins/.
  2. Go to Plugins in WP admin and click Activate next to VayaPin.

2. Activate WooCommerce​

VayaPin requires WooCommerce. If you don't already have it active, install WooCommerce 3.0+ before continuing — the VayaPin admin menu only appears when Woo is active.

3. Connect to the VayaPin API​

  1. In WP admin click the top-level Vayapin menu in the left sidebar. You'll land on Settings with the Connection tab active.
  2. Paste your API key.
  3. Choose Production or Sandbox.
  4. Click Save settings, then Run Connection Test in the Test Connection section. The status indicator should switch to Verified.

Connection tab on first run

See Connection tab for what each field does.

4. Verify checkout integration​

  1. Open your live storefront and add a product to the cart.
  2. Go to checkout and confirm the VayaPin code field is visible above the address fields.
  3. Enter a valid VayaPin code (use a test code in Sandbox).
  4. Confirm the address fields autofill.
  5. Complete a test order and open it in WooCommerce → Orders. Confirm GPS coordinates and entrance data appear in the VayaPin delivery metabox.

VayaPin field on storefront checkout

5. (Optional) Configure webhooks​

  • To receive address updates from VayaPin (VayaConnect pin.address_updated events), register your store's webhook in the VayaPin dashboard — see Connect the VayaPin webhook.
  • To forward the plugin's own events (for example a VayaPin created at checkout) to an external system, set a URL and secret in the Notifications tab.

External services​

This plugin uses the VayaPin API to resolve codes and related address or profile data during checkout and admin flows.

ServiceVayaPin API
Endpointhttps://api.vayapin.com/v1/
TermsVayaPin Terms of Use
PrivacyVayaPin Privacy Policy

Data sent to VayaPin is limited to what is needed to authenticate and to perform lookups or actions you enable. You must use a valid API token. Describe data flows accurately in your privacy policy.