YardPay Docs

QuickPay for WooCommerce

Accept payments on your WooCommerce store with YardPay's official WordPress plugin.

Installation

  1. In your WordPress admin, go to Plugins → Add New
  2. Search for "QuickPay for WooCommerce"
  3. Click Install Now, then Activate
  4. Navigate to WooCommerce → Settings → Payments → QuickPay

Manual installation

Download the plugin ZIP from the YardPay dashboard and upload it via Plugins → Add New → Upload Plugin.

Admin Settings

Configure the plugin under WooCommerce → Settings → Payments → QuickPay.

SettingDescription
Server API KeyYour sk_live_... (or sk_test_...) key. Needs the checkout.session.create scope, plus checkout.session.refund to refund from WooCommerce.
Publishable KeyYour pk_live_... key.
QuickPay API URLBase URL of the YardPay Gateway.
Webhook SecretSigning secret of your YardPay webhook. Required — orders are only marked paid from signed webhooks.

How It Works

The plugin uses YardPay's hosted checkout, in both the classic and the block-based (WooCommerce 8.3+) checkout. Card details are entered on YardPay's page, never on your store.

  1. Customer clicks "Place Order" ("Continue to QuickPay" in the block checkout)
  2. Plugin creates a checkout session via the YardPay API
  3. Customer is redirected to the hosted payment page and pays by card or wallet QR
  4. After payment, customer returns to the WooCommerce thank-you page
  5. The signed checkout.session.completed webhook marks the order paid

Refunds

Refund from the order screen with Refund via QuickPay. YardPay refunds the full order amount only: a partial refund is refused with an error and nothing is refunded. Card and wallet QR payments can be refunded until they are settled to your balance.

WooCommerce Subscriptions

Automatic renewals are not supported yet: YardPaycannot charge a saved card without the customer present. With WooCommerce Subscriptions installed, renewals fall back to manual renewal — the customer pays each renewal order through the hosted checkout.

Webhooks

The plugin automatically registers a webhook endpoint at:

https://yourstore.com/?wc-api=quickpay_webhook

Configure this URL in your YardPay dashboard under Developers → Webhooks. The plugin handles these events automatically:

  • checkout.session.completed — Marks the order paid (after checking the session, amount and currency)
  • payment.succeeded — Same, as a fallback
  • payment.failed — Adds an order note (the customer can retry on the hosted page)
  • payment.refunded — Records a refund made in YardPay (refunds made from WooCommerce are not recorded twice)

Events are verified with X-Webhook-Signature: sha256=<hex> (HMAC-SHA256 of the raw body) and de-duplicated on the event id. Other event types are acknowledged and ignored.

Important

The webhook signing secret from your YardPay dashboard must be entered in the plugin settings. Without it the endpoint rejects every event, and orders stay pending.

Requirements

  • WordPress 6.0+
  • WooCommerce 8.0+ (classic or block checkout)
  • PHP 7.4+
  • SSL certificate (HTTPS required)