Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.quickei.io/llms.txt

Use this file to discover all available pages before exploring further.

Add Quickei as a payment method in your WooCommerce store. Customers pay by scanning a QR code or via the hosted payment page — orders update automatically.

​
Requirements

RequirementMinimum Version
WordPress6.0+
WooCommerce8.0+
PHP8.1+
SSLRequired (HTTPS)
You need a Quickei merchant account with API keys. Register here if you don’t have one.

​
Installation

1

Download the plugin

Download the Quickei WooCommerce plugin from your Merchant Dashboard or from the integration page.
2

Install in WordPress

Go to Plugins > Add New > Upload Plugin in your WordPress admin. Upload the quickei-gateway.zip file and activate it.
3

Configure API keys

Navigate to WooCommerce > Settings > Payments > Quickei and enter your credentials:
  • Client ID — Your merchant API client ID
  • Client Secret — Your merchant API secret
  • Environment — Sandbox for testing, Production for live payments
4

Test a payment

Place a test order using the Sandbox environment to verify everything works before going live.

​
How It Works

​
Checkout Experience

When a customer selects Quickei at checkout:
  1. A QR code is displayed on the order confirmation page
  2. The customer scans it with the Quickei app or clicks to open the payment page
  3. Payment is confirmed in real-time — the page updates automatically
  4. The WooCommerce order moves from Pending to Processing

​
Webhook Configuration

The plugin automatically registers a webhook endpoint: 
https://your-store.com/?wc-api=quickei_webhook
All webhook payloads are verified using HMAC-SHA256 signatures with your client_secret.

​
Event Mapping

Quickei EventWooCommerce StatusDescription
pos.order.paidProcessingPayment confirmed
pos.order.expiredFailedOrder expired before payment
pos.order.cancelledCancelledOrder cancelled by merchant
pos.order.refundedRefundedPayment refunded to customer

​
Plugin Settings

SettingDescriptionDefault
Enable/DisableToggle Quickei payment methodEnabled
TitlePayment method name shown at checkout”Quickei”
DescriptionDescription shown at checkout”Pay securely with Quickei”
Client IDYour merchant API client ID—
Client SecretYour merchant API secret—
EnvironmentSandbox or ProductionSandbox
Always test in Sandbox mode first. Switch to Production only after verifying that orders, webhooks, and refunds work correctly.

​
Troubleshooting

Ensure your API keys are correct and the plugin is enabled. Check your WordPress error log at wp-content/debug.log for API response errors.
Verify the webhook URL https://your-store.com/?wc-api=quickei_webhook is publicly accessible. Check that your server allows incoming POST requests from Quickei IPs.
Quickei requires HTTPS for all API communications. Ensure your WordPress site has a valid SSL certificate and WP_HOME / WP_SITEURL use https://.