Payment Methods¶

Purpose¶

Configure payment gateway plugins and payment methods available to customers during checkout (e.g., Cash on Delivery, Credit Card, PayPal, Bank Transfer).

Accessing Payment Methods¶

Click Modules → Delivery & Payments → Payment Methods

List View¶

Payment Methods List

The list displays all configured payment methods and their plugin settings.

Table Columns¶

Name¶

Format: Text (up to 255 characters)
Purpose: Internal identifier for this payment method configuration

Display Name¶

Format: Text (up to 255 characters)
Purpose: Customer-facing label shown during checkout

Logo¶

Format: Image thumbnail (square, 40px)
Purpose: Payment method icon displayed to customers

Plugin Name¶

Format: Text
Purpose: Name of the payment plugin powering this method

Enabled¶

Format: Icon toggle (checkmark = enabled, X = disabled)
Purpose: Whether this payment method is available to customers

Sort Order¶

Format: Number
Purpose: Display order in customer checkout (lower numbers appear first)

Row Actions¶

Edit: Configure payment method settings
Test: Test payment gateway connection (if available)

Bulk Actions¶

Delete: Remove multiple payment methods
Export: Export payment method data to Excel/CSV

Creating a Payment Method¶

Create Payment Method

Click "New Payment Method" to add a new payment option.

Basic Information Section¶

Name Required¶

Type: Text input (max 255 characters)
Purpose: Internal name for tracking
Examples: "COD", "Credit Card Stripe", "PayPal Express"

Display Name Optional¶

Type: Text input (max 255 characters)
Purpose: Name shown to customers at checkout
Default: Uses Name if not specified

Description Optional¶

Type: Text area (3 rows)
Purpose: Additional information shown to customers
Examples: "Pay in full when your order is delivered", "Fast and secure payment"

Logo Optional¶

Type: File upload (image only)
Purpose: Payment method icon displayed at checkout
Format: Images are stored publicly

Enabled Optional¶

Type: Toggle switch (On/Off)
Default: On (enabled)
Purpose: Show this payment method to customers

Sort Order Optional¶

Type: Number input (default 0)
Purpose: Position in payment method list (lower numbers appear first)

Plugin Configuration Section¶

Payment Plugin Required¶

Type: Searchable dropdown
Purpose: Select the payment gateway to use
Options: Available payment plugins (Stripe, PayPal, Bank Transfer, Cash on Delivery, etc.)

Plugin Information¶

Type: Informational text
Purpose: Shows plugin description and documentation

Plugin Settings Section¶

Dynamic Plugin Fields Varies by Plugin¶

Type: Varies (text, password, number, checkbox, select)
Purpose: Plugin-specific configuration (API keys, merchant IDs, webhook settings, etc.)
Storage: Stored securely in settings field

Common Settings Examples:

API Key / Secret Key
Merchant ID
Store ID
Webhook URL
Test Mode toggle

Create Actions¶

Create: Save and return to list
Create & Create Another: Save and open blank form for next entry
Cancel: Discard changes

Editing a Payment Method¶

Click the Edit icon to modify a payment method's settings or update plugin credentials.

Edit Payment Method

Testing Payment Gateway¶

Click the Test button (if available) to verify the payment gateway connection and credentials.

Key Information¶

Super Admin Only: Only super admin can manage payment methods
Plugin-Based: Each method uses a payment plugin for processing
Customer Visibility: Disabled methods don't appear at checkout
Sort Order: Controls order payment methods appear during checkout
Plugin Credentials: Stored securely per payment method
Multiple Methods: Configure multiple methods for customer convenience
Test Mode: Most plugins support test/production mode switching in plugin settings

Available Payment Plugins¶

The system includes several built-in payment plugins. Each plugin has specific configuration requirements.

HyperPay¶

A payment gateway popular in the Middle East, supporting multiple card brands through COPYandPAY widget integration.

Configuration Settings:

Setting	Description
Entity ID (Test)	HyperPay Entity ID for test environment
Access Token (Test)	HyperPay Access Token for test environment
Base URL (Test)	Test environment URL (default: https://eu-test.oppwa.com)
Entity ID (Production)	HyperPay Entity ID for production
Access Token (Production)	HyperPay Access Token for production
Base URL (Production)	Production environment URL (default: https://eu-prod.oppwa.com)
Supported Brands	Card brands to accept (e.g., VISA MASTER AMEX)
Test Mode	Toggle between test and production environments

Getting Credentials: 1. Register for a HyperPay merchant account 2. Access the HyperPay developer portal 3. Obtain Entity ID and Access Token for both environments 4. Configure supported card brands based on your agreement

Paymob¶

A payment gateway with regional support for Egypt, Saudi Arabia, Oman, and UAE.