Features of PrestaShop Airwallex Payment Module<\/h3>\n<\/div><\/div>\n\n\n\n\n- Dual checkout modes: hosted redirect or embedded inline card form.<\/li>\n\n\n\n
- Subscription plan management with configurable frequency and billing cycles.<\/li>\n\n\n\n
- Product-to-plan assignments supporting specific combinations.<\/li>\n\n\n\n
- Full and partial refund processing from the admin panel.<\/li>\n\n\n\n
- Automated Airwallex webhook handling with signature validation.<\/li>\n\n\n\n
- Transaction list view with filtering and detail panels.<\/li>\n\n\n\n
- Admin order panel integration with Airwallex activity and refund form.<\/li>\n\n\n\n
- Customer-facing subscription management page.<\/li>\n\n\n\n
- Multi-environment support (Demo and Production).<\/li>\n\n\n\n
- Multi-store compatible with per-shop plan scoping.<\/li>\n\n\n\n
- Request rate limiting on express checkout endpoints.<\/li>\n\n\n\n
- Duplicate webhook event detection and prevention.<\/li>\n\n\n\n
- Transaction data refresh to sync latest state from Airwallex.<\/li>\n\n\n\n
- Cart conflict prevention for mixed subscription and one-time products.<\/li>\n\n\n\n
- Rebate history tracking and credit slip generation.<\/li>\n<\/ul>\n\n\n\n\n
How to install the module<\/h3>\n<\/div><\/div>\n\n\n\n\n- Firstly, go to the module manager in the back office and click on \u2018upload a module\u2019.<\/li>\n\n\n\n
- After that, drag and drop the module file or select the file from the system.<\/li>\n\n\n\n
- In this way, the module installation will be successful.<\/li>\n<\/ul>\n\n\n\n
![\"click](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2025\/12\/click-here-to-upload-module-1200x521.webp\")
<\/figure>\n\n\n\n![\"upload](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2025\/12\/upload-the-module-here.webp\")
<\/figure>\n\n\n\n![\"configure](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2025\/12\/configure-module-1200x606.webp\")
<\/figure>\n\n\n\n\nHow to Create an Airwallex Account and Get API Keys<\/strong><\/h3>\n<\/div><\/div>\n\n\n\nStep 1 \u2014 Create an Account<\/strong><\/h4>\n\n\n\nNavigate to https:\/\/www.airwallex.com\/ and sign up for an Airwallex account. If you already have an account, log in to the Airwallex Dashboard.<\/p>\n\n\n\n
Step 2 \u2014 Find Your Billing Legal Entity ID<\/strong><\/p>\n\n\n\nIn the Airwallex Dashboard, go to Settings \u2192 Entities. Copy the Legal entity ID and paste it into the module’s configuration page.<\/p>\n\n\n\n
Step 3 \u2014 Find Your Linked Payment Account ID<\/strong><\/p>\n\n\n\nIn the Airwallex Dashboard, select to Account.<\/p>\n\n\n\n![\"select](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/09\/linked-payment-account-id-1200x881.webp\")
<\/figure>\n\n\n\nThen go to the “Accounts” section and click on the account.<\/p>\n\n\n\n![\"select](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/09\/select-account-1200x481.webp\")
<\/figure>\n\n\n\nThen copy the Linked Payment Account ID and paste it to the module configuration page.<\/p>\n\n\n\n![\"business](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/09\/business-id-1200x574.webp\")
<\/figure>\n\n\n\nStep 4 \u2014 Find Your Admin Client ID API Credentials<\/strong><\/h4>\n\n\n\nIn the Airwallex Dashboard, go to Developers \u2192 API keys \u2192 Admin keys. Copy the Client ID and paste it into the module’s configuration page.<\/p>\n\n\n\n![\"Admin](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/09\/admin-client-id-1200x664.webp\")
<\/figure>\n\n\n\nStep 5 \u2014 Find Your Admin API Credentials<\/strong><\/p>\n\n\n\nIn the Airwallex Dashboard, go to Developers \u2192 API keys \u2192 Admin keys \u2192 click on the 3 dots \u2192 click on “Regenerate” and enter the account password.<\/p>\n\n\n\n![\"regenerate\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/09\/regenerate-1200x574.webp\")
<\/figure>\n\n\n\n![\"API](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/09\/api-cred-1200x574.webp\")
<\/figure>\n\n\n\nCopy the API key and paste it to the module configuration field.<\/p>\n\n\n\n
Step 5 \u2014 Generate Webhook secret<\/strong><\/p>\n\n\n\nIn the Airwallex Dashboard, go to Developers \u2192 Webhooks \u2192 Add New webhook.<\/p>\n\n\n\n![\"webhook](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/09\/webhook-tab-1200x574.webp\")
<\/figure>\n\n\n\nNow, enter the required fields, select the account, grant event permissions and click on “Create” button.<\/p>\n\n\n\n![\"enter](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/09\/permissions-1200x574.webp\")
<\/figure>\n\n\n\nCopy the newly generated webhook API secret and paste it to the module configuration page. <\/p>\n\n\n\n![\"webhook](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/09\/webhook-cred-1200x944.webp\")
<\/figure>\n\n\n\n\nPrestaShop Airwallex Payments Module Configuration<\/strong><\/h3>\n<\/div><\/div>\n\n\n\nNavigate to: Modules \u2192 Module Manager \u2192 Airwallex Payments Pro \u2192 Configure.<\/p>\n\n\n\n![\"Configuration\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/09\/conf-1200x963.webp\")
<\/figure>\n\n\n\nEnvironment<\/strong><\/h4>\n\n\n\nSelect whether the module should communicate with the Airwallex Demo (Sandbox) or Production (live) environment. This determines which set of API credentials is used.<\/p>\n\n\n\n
\n- Demo (Sandbox): Use for testing payments without real charges.<\/li>\n\n\n\n
- Production: Use for live transactions with real money.<\/li>\n<\/ul>\n\n\n\n
Payment through hosted payment page<\/strong><\/h4>\n\n\n\nChoose the checkout mode for your store.<\/p>\n\n\n\n
\n- Yes:<\/strong> Customers will redirect to the Airwallex hosted checkout page to complete payment.<\/li>\n\n\n\n
- No:<\/strong> An inline card form appears directly on the PrestaShop checkout page.<\/li>\n<\/ul>\n\n\n\n
Billing legal entity ID<\/strong><\/h4>\n\n\n\nPaste your Airwallex billing legal entity ID here. This is required when ‘Payment through hosted payment page’ is set to Yes, and is also required for subscription checkouts.<\/p>\n\n\n\n
Linked payment account ID<\/strong><\/h4>\n\n\n\nPaste your Airwallex linked payment account ID here. This is required when ‘Payment through hosted payment page’ is set to Yes, and is also required for subscription checkouts.<\/p>\n\n\n\n
Client ID<\/strong><\/h4>\n\n\n\nEnter your Airwallex Client ID for the currently selected environment. The module validates this credential on save by making a test API call to Airwallex.<\/p>\n\n\n\n
API key<\/strong><\/p>\n\n\n\nEnter your Airwallex API key for the currently selected environment. The module validates this credential on save by making a test API call to Airwallex.<\/p>\n\n\n\n
Webhook status<\/strong><\/p>\n\n\n\nDisplays the current webhook registration status. After saving valid credentials, the module automatically registers the webhook endpoint with Airwallex and stores the signing secret.<\/p>\n\n\n\n
Webhook URL<\/strong><\/h4>\n\n\n\nThe URL Airwallex sends webhook events to. This will generate automatically based on your store domain and cannot be edited.<\/p>\n\n\n\n
Webhook secret<\/strong><\/h4>\n\n\n\nEnter the webhook signing secret provided by Airwallex. This is used to validate that incoming webhook requests actually originate from Airwallex.<\/p>\n\n\n\n
Validate and save<\/strong><\/h4>\n\n\n\nClick this button to validate your Airwallex credentials, save all configuration values, store the webhook secret, and register the webhook endpoint with Airwallex.<\/p>\n\n\n\n
\n- On success:<\/strong> displays a confirmation message and updates the connection status to ‘Connected’.<\/li>\n\n\n\n
- On failure:<\/strong> displays validation errors if credentials are invalid or fields are missing.<\/li>\n<\/ul>\n\n\n\n
Re-register webhook<\/strong><\/h4>\n\n\n\nClick this button to re-register the webhook endpoint with Airwallex without re-saving all credentials. Useful if the webhook deletes or needs to refresh.<\/p>\n\n\n\n
\n- On success:<\/strong> displays a confirmation message and updates the webhook status to ‘Webhook active’.<\/li>\n\n\n\n
- On failure:<\/strong> displays an error if the webhook secret is missing or the registration fails.<\/li>\n<\/ul>\n\n\n\n
After entering all settings, click Save to apply the configuration.<\/p>\n\n\n\n
\nManaging Airwallex Payments from the Admin Panel<\/strong><\/h3>\n<\/div><\/div>\n\n\n\nAirwallex Payments Menu<\/strong><\/p>\n\n\n\nAfter installation, the module adds the following four submenu options under the ‘Airwallex’ menu option: <\/p>\n\n\n\n
\n- Transactions<\/li>\n\n\n\n
- Subscription plans <\/li>\n\n\n\n
- Plan products<\/li>\n\n\n\n
- Subscriptions<\/li>\n<\/ul>\n\n\n\n
Transactions<\/strong><\/h3>\n\n\n\nThe Transactions panel lists all payment records stored by the module. The admin can filter the list by intent ID, checkout ID, subscription ID, status, order, and date.<\/p>\n\n\n\n![\"transaction\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/09\/txn-1200x574.webp\")
<\/figure>\n\n\n\nEach row shows: ID, Intent ID, Checkout ID, Subscription ID, Status, Order amount, Refunded amount, Order, and Date. Click the ‘view’ icon on any row to open the transaction detail page.<\/p>\n\n\n\n
The detail page shows: <\/p>\n\n\n\n
\n- Transaction reference<\/li>\n\n\n\n
- Airwallex intent ID<\/li>\n\n\n\n
- Airwallex checkout ID <\/li>\n\n\n\n
- Airwallex payment ID <\/li>\n\n\n\n
- Status<\/li>\n\n\n\n
- Order amount<\/li>\n\n\n\n
- Settlement amount<\/li>\n\n\n\n
- Captured amount<\/li>\n\n\n\n
- Refunded amount<\/li>\n\n\n\n
- Refund panel<\/li>\n<\/ul>\n\n\n\n
![\"txn](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/09\/txn-detail-page-1200x984.webp\")
<\/figure>\n\n\n\n\n- The refund panel supports full refunds (one-click) and partial refunds.<\/li>\n<\/ul>\n\n\n\n
![\"partial](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/09\/partial-refund-1149x1024.webp\")
<\/figure>\n\n\n\n\n- The detail page also shows a refund history table with refund reference, Airwallex refund ID, amount, credit slip link, and creation date.<\/li>\n<\/ul>\n\n\n\n
![\"refund](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/09\/refund-history-1200x260.webp\")
<\/figure>\n\n\n\n\n- Status options in the filter: Created, Authorized, Captured, Partially refunded, Refunded.<\/li>\n<\/ul>\n\n\n\n
Subscription plans<\/strong><\/h3>\n\n\n\nThe Subscription plans panel lets you create and manage recurring billing plans.<\/p>\n\n\n\n![\"Subscription](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/09\/subscription-plan-1-1200x495.webp\")
<\/figure>\n\n\n\n\n- Each row shows:<\/strong> ID, Plan name, Frequency, Frequency interval, Cycles, Status, and Update date.<\/li>\n\n\n\n
- Click ‘edit<\/strong>‘ on a row to open the plan edit form, or use the ‘Add new plan’ header button to create a plan.<\/li>\n\n\n\n
- Bulk actions: <\/strong>delete selected plans (plans in use cannot be deleted).<\/li>\n\n\n\n
- Status can be toggled inline \u2014 yes\/no switch updates the active flag for the current shop context.<\/li>\n<\/ul>\n\n\n\n
Create Subscription Plan Form<\/strong><\/p>\n\n\n\n![\"create](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/09\/create-plan-1200x659.webp\")
<\/figure>\n\n\n\n\n- Plan name:<\/strong> The name shown to customers and in the admin.<\/li>\n\n\n\n
- Frequency:<\/strong> Day, Week, Month, or Year.<\/li>\n\n\n\n
- Frequency interval:<\/strong> The number of frequency units between billings. Allowed ranges: day 1-365, week 1-52, month 1-12, year 1-100.<\/li>\n\n\n\n
- Cycles:<\/strong> Number of billing cycles. Set 0 for unlimited.<\/li>\n\n\n\n
- Status:<\/strong> Active (Yes) or inactive (No).<\/li>\n\n\n\n
- Save button:<\/strong> saves and returns to the list.<\/li>\n\n\n\n
- Save and stay button:<\/strong> saves and keeps the form open for further edits.<\/li>\n\n\n\n
- Back to list button:<\/strong> returns to the list without saving.<\/li>\n<\/ul>\n\n\n\n
Plan products<\/strong><\/h3>\n\n\n\nThe Plan products panel manages the assignment of subscription plans to products. Assignments link a plan to a specific product or product combination.<\/p>\n\n\n\n![\"plan](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/09\/plan-product-list-1200x777.webp\")
<\/figure>\n\n\n\n\n- Each row shows: ID, Plan name, Product ID, Product name (with combination attributes), Preview\/View, and Update date.<\/li>\n\n\n\n
- The ‘Preview\/View’ column links to the front-office product page for the assigned product.<\/li>\n\n\n\n
- Click ‘add’ or use the ‘Add plan product’ header button to open the assignment form.<\/li>\n\n\n\n
- Bulk delete: remove selected assignments.<\/li>\n<\/ul>\n\n\n\n
Assign Subscription Plan to Products<\/strong><\/h4>\n\n\n\n![\"Assign](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/09\/assign-plan-1200x531.webp\")
<\/figure>\n\n\n\n\n- Product search<\/strong>: type to search and select a product from your catalog.<\/li>\n\n\n\n
- Plan selection<\/strong>: choose which subscription plan to assign.<\/li>\n\n\n\n
- All combinations checkbox<\/strong>: if checked, the plan applies to all combinations of the product.<\/li>\n\n\n\n
- Specific combinations<\/strong>: select which combinations the plan applies to (only shown when ‘All combinations’ is unchecked).<\/li>\n\n\n\n
- Submit<\/strong>: saves the assignment and returns to the list.<\/li>\n<\/ul>\n\n\n\n
Note<\/strong>: A product can only be assigned to one plan at a time.<\/p>\n\n\n\nSubscriptions<\/strong><\/p>\n\n\n\nThe Subscriptions panel lists every subscription record created through the module. Subscriptions are listed per the current shop context.<\/p>\n\n\n\n![\"subscription](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/09\/subscription-list-1200x350.webp\")
<\/figure>\n\n\n\n\n- Each row shows<\/strong>: ID, Subscription code, Plan name, Airwallex subscription ID, Billing customer ID, Payment source ID, Status, Last order, and Shop (all-shops context only).<\/li>\n\n\n\n
- Status options<\/strong>: Active, Pending, Cancelled.<\/li>\n\n\n\n
- Click ‘view<\/strong>‘ on a row to open the subscription detail page.<\/li>\n\n\n\n
- Click the ‘Cancel<\/strong>‘ action icon to cancel an active subscription \u2014 this sends a cancellation request to Airwallex and updates the local record.<\/li>\n<\/ul>\n\n\n\n
![\"subscription](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/09\/subscription-details-1184x1024.webp\")
<\/figure>\n\n\n\nThe subscription detail page shows: status, plan name, billing frequency, amount, billing date, start\/end period, cancelled at, last order, created at, updated at, and a transaction history table.<\/p>\n\n\n\n
The transaction history table in the subscription view shows each transaction’s reference, type (initial\/recurring), status, amount, associated order (with link), and date.<\/p>\n\n\n\n
\n- The ‘Back to list’ button returns to the subscriptions list.<\/li>\n<\/ul>\n\n\n\n\n
Storefront Experience<\/strong><\/h3>\n<\/div><\/div>\n\n\n\nWhen a customer proceeds to checkout, the Airwallex payment option appears on the payment selection step. <\/p>\n\n\n\n
The option is labeled ‘Pay by Airwallex payment’. The behavior depends on the configured checkout mode.<\/p>\n\n\n\n
Hosted Checkout Mode<\/strong><\/h3>\n\n\n\nWhen ‘Payment through hosted payment page’ is set to Yes, clicking the Airwallex payment option redirects the customer to Airwallex’s secure hosted checkout page.<\/p>\n\n\n\n![\"payment](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/09\/payment-hosted-1200x667.webp\")
<\/figure>\n\n\n\n![\"airwallex\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/09\/airwallex-1188x1024.webp\")
<\/figure>\n\n\n\nThe page displays the order total, currency, and line items. After successful payment, the customer is redirected back to your store’s order confirmation page.<\/p>\n\n\n\n![\"order](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/09\/payment-page-985x1024.webp\")
<\/figure>\n\n\n\nEmbedded Checkout Mode<\/strong><\/h3>\n\n\n\nWhen ‘Payment through hosted payment page’ is set to “No”. An inline card form is rendered on the checkout page using the Airwallex JavaScript SDK. <\/p>\n\n\n\n
Customers enter their card number, expiry date, and CVC directly in a secure field hosted by Airwallex. <\/p>\n\n\n\n
Real-time validation indicates whether the card number, expiry, and CVC are valid.<\/p>\n\n\n\n![\"checkout](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/09\/checkout-page-1200x872.webp\")
<\/figure>\n\n\n\nSubscription Product Experience<\/strong><\/p>\n\n\n\nWhen a product is assigned a subscription plan, customers see a purchase option selector on the product page and in the cart. <\/p>\n\n\n\n
They can choose between a one-time purchase and subscribing to the product with the selected billing frequency.<\/p>\n\n\n\n![\"product](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/09\/product-page-1200x859.webp\")
<\/figure>\n\n\n\n\n- On the product page, a subscription selector appears below the price showing ‘One-time purchase’ (standard pricing) and ‘Subscribe’ (recurring with the plan’s interval phrase, e.g. ‘Same price, every month’).<\/li>\n\n\n\n
- In the cart, a badge ‘Subscription product’ appears next to assigned products.<\/li>\n<\/ul>\n\n\n\n
![\"cart](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/09\/cart-page-1200x535.webp\")
<\/figure>\n\n\n\n\n- Cart conflict handling: if a customer tries to add a subscription product while another subscription product is already in the cart, a warning will display ‘Only one subscription product can be purchased in a single checkout.’<\/li>\n<\/ul>\n\n\n\n
![\"dual](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/09\/dual-susbcription-1200x924.webp\")
<\/figure>\n\n\n\n\n- If a customer tries to mix subscription and non-subscription products in the same cart, the subscription product will block and an error message will display at the top of the cart.<\/li>\n<\/ul>\n\n\n\n
![\"one](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/09\/one-subscription-one-normal-1200x574.webp\")
<\/figure>\n\n\n\nCustomer Subscription Management Page<\/strong><\/h3>\n\n\n\nLogged-in customers can access their subscriptions via the ‘My Subscription’ link in their account navigation. This page lists all subscriptions associated with the customer’s account.<\/p>\n\n\n\n![\"susbcription-customer\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/09\/susbcription-customer-1200x549.webp\")
<\/figure>\n\n\n\n\n- The list shows: subscription ID, status, subscription code, Airwallex subscription ID, payment source ID, next billing date, and action buttons (View and Cancel).<\/li>\n\n\n\n
- Clicking ‘View’ opens the subscription detail page showing full billing information, period dates, payment history, and a cancel button.<\/li>\n<\/ul>\n\n\n\n
![\"subscription](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/09\/subscription-detail-1200x574.webp\")
<\/figure>\n\n\n\n\n- Clicking ‘Cancel’ prompts for confirmation. If confirmed, the subscription will be cancel at Airwallex and the local record will update.<\/li>\n\n\n\n
- Cancelled subscriptions display a ‘Cancelled’ label instead of the cancel button.<\/li>\n<\/ul>\n\n\n\n
Support<\/h3>\n\n\n\n
For any kind of technical assistance or query, please raise a ticket<\/a> or send us a mail at support@webkul.com<\/strong><\/p>\n\n\n\nAlso, please explore our Prestashop development services<\/a> and vast range of quality Prestashop addons<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"
How to install the module<\/h3>\n<\/div><\/div>\n\n\n\n\n- Firstly, go to the module manager in the back office and click on \u2018upload a module\u2019.<\/li>\n\n\n\n
- After that, drag and drop the module file or select the file from the system.<\/li>\n\n\n\n
- In this way, the module installation will be successful.<\/li>\n<\/ul>\n\n\n\n
<\/figure>\n\n\n\n<\/figure>\n\n\n\n<\/figure>\n\n\n\n\nHow to Create an Airwallex Account and Get API Keys<\/strong><\/h3>\n<\/div><\/div>\n\n\n\nStep 1 \u2014 Create an Account<\/strong><\/h4>\n\n\n\nNavigate to https:\/\/www.airwallex.com\/ and sign up for an Airwallex account. If you already have an account, log in to the Airwallex Dashboard.<\/p>\n\n\n\n
Step 2 \u2014 Find Your Billing Legal Entity ID<\/strong><\/p>\n\n\n\nIn the Airwallex Dashboard, go to Settings \u2192 Entities. Copy the Legal entity ID and paste it into the module’s configuration page.<\/p>\n\n\n\n
Step 3 \u2014 Find Your Linked Payment Account ID<\/strong><\/p>\n\n\n\nIn the Airwallex Dashboard, select to Account.<\/p>\n\n\n\n<\/figure>\n\n\n\nThen go to the “Accounts” section and click on the account.<\/p>\n\n\n\n<\/figure>\n\n\n\nThen copy the Linked Payment Account ID and paste it to the module configuration page.<\/p>\n\n\n\n<\/figure>\n\n\n\nStep 4 \u2014 Find Your Admin Client ID API Credentials<\/strong><\/h4>\n\n\n\nIn the Airwallex Dashboard, go to Developers \u2192 API keys \u2192 Admin keys. Copy the Client ID and paste it into the module’s configuration page.<\/p>\n\n\n\n<\/figure>\n\n\n\nStep 5 \u2014 Find Your Admin API Credentials<\/strong><\/p>\n\n\n\nIn the Airwallex Dashboard, go to Developers \u2192 API keys \u2192 Admin keys \u2192 click on the 3 dots \u2192 click on “Regenerate” and enter the account password.<\/p>\n\n\n\n<\/figure>\n\n\n\n<\/figure>\n\n\n\nCopy the API key and paste it to the module configuration field.<\/p>\n\n\n\n
Step 5 \u2014 Generate Webhook secret<\/strong><\/p>\n\n\n\nIn the Airwallex Dashboard, go to Developers \u2192 Webhooks \u2192 Add New webhook.<\/p>\n\n\n\n<\/figure>\n\n\n\nNow, enter the required fields, select the account, grant event permissions and click on “Create” button.<\/p>\n\n\n\n<\/figure>\n\n\n\nCopy the newly generated webhook API secret and paste it to the module configuration page. <\/p>\n\n\n\n<\/figure>\n\n\n\n\nPrestaShop Airwallex Payments Module Configuration<\/strong><\/h3>\n<\/div><\/div>\n\n\n\nNavigate to: Modules \u2192 Module Manager \u2192 Airwallex Payments Pro \u2192 Configure.<\/p>\n\n\n\n<\/figure>\n\n\n\nEnvironment<\/strong><\/h4>\n\n\n\nSelect whether the module should communicate with the Airwallex Demo (Sandbox) or Production (live) environment. This determines which set of API credentials is used.<\/p>\n\n\n\n
\n- Demo (Sandbox): Use for testing payments without real charges.<\/li>\n\n\n\n
- Production: Use for live transactions with real money.<\/li>\n<\/ul>\n\n\n\n
Payment through hosted payment page<\/strong><\/h4>\n\n\n\nChoose the checkout mode for your store.<\/p>\n\n\n\n
\n- Yes:<\/strong> Customers will redirect to the Airwallex hosted checkout page to complete payment.<\/li>\n\n\n\n
- No:<\/strong> An inline card form appears directly on the PrestaShop checkout page.<\/li>\n<\/ul>\n\n\n\n
Billing legal entity ID<\/strong><\/h4>\n\n\n\nPaste your Airwallex billing legal entity ID here. This is required when ‘Payment through hosted payment page’ is set to Yes, and is also required for subscription checkouts.<\/p>\n\n\n\n
Linked payment account ID<\/strong><\/h4>\n\n\n\nPaste your Airwallex linked payment account ID here. This is required when ‘Payment through hosted payment page’ is set to Yes, and is also required for subscription checkouts.<\/p>\n\n\n\n
Client ID<\/strong><\/h4>\n\n\n\nEnter your Airwallex Client ID for the currently selected environment. The module validates this credential on save by making a test API call to Airwallex.<\/p>\n\n\n\n
API key<\/strong><\/p>\n\n\n\nEnter your Airwallex API key for the currently selected environment. The module validates this credential on save by making a test API call to Airwallex.<\/p>\n\n\n\n
Webhook status<\/strong><\/p>\n\n\n\nDisplays the current webhook registration status. After saving valid credentials, the module automatically registers the webhook endpoint with Airwallex and stores the signing secret.<\/p>\n\n\n\n
Webhook URL<\/strong><\/h4>\n\n\n\nThe URL Airwallex sends webhook events to. This will generate automatically based on your store domain and cannot be edited.<\/p>\n\n\n\n
Webhook secret<\/strong><\/h4>\n\n\n\nEnter the webhook signing secret provided by Airwallex. This is used to validate that incoming webhook requests actually originate from Airwallex.<\/p>\n\n\n\n
Validate and save<\/strong><\/h4>\n\n\n\nClick this button to validate your Airwallex credentials, save all configuration values, store the webhook secret, and register the webhook endpoint with Airwallex.<\/p>\n\n\n\n
\n- On success:<\/strong> displays a confirmation message and updates the connection status to ‘Connected’.<\/li>\n\n\n\n
- On failure:<\/strong> displays validation errors if credentials are invalid or fields are missing.<\/li>\n<\/ul>\n\n\n\n
Re-register webhook<\/strong><\/h4>\n\n\n\nClick this button to re-register the webhook endpoint with Airwallex without re-saving all credentials. Useful if the webhook deletes or needs to refresh.<\/p>\n\n\n\n
\n- On success:<\/strong> displays a confirmation message and updates the webhook status to ‘Webhook active’.<\/li>\n\n\n\n
- On failure:<\/strong> displays an error if the webhook secret is missing or the registration fails.<\/li>\n<\/ul>\n\n\n\n
After entering all settings, click Save to apply the configuration.<\/p>\n\n\n\n
\nManaging Airwallex Payments from the Admin Panel<\/strong><\/h3>\n<\/div><\/div>\n\n\n\nAirwallex Payments Menu<\/strong><\/p>\n\n\n\nAfter installation, the module adds the following four submenu options under the ‘Airwallex’ menu option: <\/p>\n\n\n\n
\n- Transactions<\/li>\n\n\n\n
- Subscription plans <\/li>\n\n\n\n
- Plan products<\/li>\n\n\n\n
- Subscriptions<\/li>\n<\/ul>\n\n\n\n
Transactions<\/strong><\/h3>\n\n\n\nThe Transactions panel lists all payment records stored by the module. The admin can filter the list by intent ID, checkout ID, subscription ID, status, order, and date.<\/p>\n\n\n\n<\/figure>\n\n\n\nEach row shows: ID, Intent ID, Checkout ID, Subscription ID, Status, Order amount, Refunded amount, Order, and Date. Click the ‘view’ icon on any row to open the transaction detail page.<\/p>\n\n\n\n
The detail page shows: <\/p>\n\n\n\n
\n- Transaction reference<\/li>\n\n\n\n
- Airwallex intent ID<\/li>\n\n\n\n
- Airwallex checkout ID <\/li>\n\n\n\n
- Airwallex payment ID <\/li>\n\n\n\n
- Status<\/li>\n\n\n\n
- Order amount<\/li>\n\n\n\n
- Settlement amount<\/li>\n\n\n\n
- Captured amount<\/li>\n\n\n\n
- Refunded amount<\/li>\n\n\n\n
- Refund panel<\/li>\n<\/ul>\n\n\n\n
<\/figure>\n\n\n\n\n- The refund panel supports full refunds (one-click) and partial refunds.<\/li>\n<\/ul>\n\n\n\n
<\/figure>\n\n\n\n\n- The detail page also shows a refund history table with refund reference, Airwallex refund ID, amount, credit slip link, and creation date.<\/li>\n<\/ul>\n\n\n\n
<\/figure>\n\n\n\n\n- Status options in the filter: Created, Authorized, Captured, Partially refunded, Refunded.<\/li>\n<\/ul>\n\n\n\n
Subscription plans<\/strong><\/h3>\n\n\n\nThe Subscription plans panel lets you create and manage recurring billing plans.<\/p>\n\n\n\n<\/figure>\n\n\n\n\n- Each row shows:<\/strong> ID, Plan name, Frequency, Frequency interval, Cycles, Status, and Update date.<\/li>\n\n\n\n
- Click ‘edit<\/strong>‘ on a row to open the plan edit form, or use the ‘Add new plan’ header button to create a plan.<\/li>\n\n\n\n
- Bulk actions: <\/strong>delete selected plans (plans in use cannot be deleted).<\/li>\n\n\n\n
- Status can be toggled inline \u2014 yes\/no switch updates the active flag for the current shop context.<\/li>\n<\/ul>\n\n\n\n
Create Subscription Plan Form<\/strong><\/p>\n\n\n\n<\/figure>\n\n\n\n\n- Plan name:<\/strong> The name shown to customers and in the admin.<\/li>\n\n\n\n
- Frequency:<\/strong> Day, Week, Month, or Year.<\/li>\n\n\n\n
- Frequency interval:<\/strong> The number of frequency units between billings. Allowed ranges: day 1-365, week 1-52, month 1-12, year 1-100.<\/li>\n\n\n\n
- Cycles:<\/strong> Number of billing cycles. Set 0 for unlimited.<\/li>\n\n\n\n
- Status:<\/strong> Active (Yes) or inactive (No).<\/li>\n\n\n\n
- Save button:<\/strong> saves and returns to the list.<\/li>\n\n\n\n
- Save and stay button:<\/strong> saves and keeps the form open for further edits.<\/li>\n\n\n\n
- Back to list button:<\/strong> returns to the list without saving.<\/li>\n<\/ul>\n\n\n\n
Plan products<\/strong><\/h3>\n\n\n\nThe Plan products panel manages the assignment of subscription plans to products. Assignments link a plan to a specific product or product combination.<\/p>\n\n\n\n<\/figure>\n\n\n\n\n- Each row shows: ID, Plan name, Product ID, Product name (with combination attributes), Preview\/View, and Update date.<\/li>\n\n\n\n
- The ‘Preview\/View’ column links to the front-office product page for the assigned product.<\/li>\n\n\n\n
- Click ‘add’ or use the ‘Add plan product’ header button to open the assignment form.<\/li>\n\n\n\n
- Bulk delete: remove selected assignments.<\/li>\n<\/ul>\n\n\n\n
Assign Subscription Plan to Products<\/strong><\/h4>\n\n\n\n<\/figure>\n\n\n\n\n- Product search<\/strong>: type to search and select a product from your catalog.<\/li>\n\n\n\n
- Plan selection<\/strong>: choose which subscription plan to assign.<\/li>\n\n\n\n
- All combinations checkbox<\/strong>: if checked, the plan applies to all combinations of the product.<\/li>\n\n\n\n
- Specific combinations<\/strong>: select which combinations the plan applies to (only shown when ‘All combinations’ is unchecked).<\/li>\n\n\n\n
- Submit<\/strong>: saves the assignment and returns to the list.<\/li>\n<\/ul>\n\n\n\n
Note<\/strong>: A product can only be assigned to one plan at a time.<\/p>\n\n\n\nSubscriptions<\/strong><\/p>\n\n\n\nThe Subscriptions panel lists every subscription record created through the module. Subscriptions are listed per the current shop context.<\/p>\n\n\n\n<\/figure>\n\n\n\n\n- Each row shows<\/strong>: ID, Subscription code, Plan name, Airwallex subscription ID, Billing customer ID, Payment source ID, Status, Last order, and Shop (all-shops context only).<\/li>\n\n\n\n
- Status options<\/strong>: Active, Pending, Cancelled.<\/li>\n\n\n\n
- Click ‘view<\/strong>‘ on a row to open the subscription detail page.<\/li>\n\n\n\n
- Click the ‘Cancel<\/strong>‘ action icon to cancel an active subscription \u2014 this sends a cancellation request to Airwallex and updates the local record.<\/li>\n<\/ul>\n\n\n\n
<\/figure>\n\n\n\nThe subscription detail page shows: status, plan name, billing frequency, amount, billing date, start\/end period, cancelled at, last order, created at, updated at, and a transaction history table.<\/p>\n\n\n\n
The transaction history table in the subscription view shows each transaction’s reference, type (initial\/recurring), status, amount, associated order (with link), and date.<\/p>\n\n\n\n
\n- The ‘Back to list’ button returns to the subscriptions list.<\/li>\n<\/ul>\n\n\n\n\n
Storefront Experience<\/strong><\/h3>\n<\/div><\/div>\n\n\n\nWhen a customer proceeds to checkout, the Airwallex payment option appears on the payment selection step. <\/p>\n\n\n\n
The option is labeled ‘Pay by Airwallex payment’. The behavior depends on the configured checkout mode.<\/p>\n\n\n\n
Hosted Checkout Mode<\/strong><\/h3>\n\n\n\nWhen ‘Payment through hosted payment page’ is set to Yes, clicking the Airwallex payment option redirects the customer to Airwallex’s secure hosted checkout page.<\/p>\n\n\n\n<\/figure>\n\n\n\n<\/figure>\n\n\n\nThe page displays the order total, currency, and line items. After successful payment, the customer is redirected back to your store’s order confirmation page.<\/p>\n\n\n\n<\/figure>\n\n\n\nEmbedded Checkout Mode<\/strong><\/h3>\n\n\n\nWhen ‘Payment through hosted payment page’ is set to “No”. An inline card form is rendered on the checkout page using the Airwallex JavaScript SDK. <\/p>\n\n\n\n
Customers enter their card number, expiry date, and CVC directly in a secure field hosted by Airwallex. <\/p>\n\n\n\n
Real-time validation indicates whether the card number, expiry, and CVC are valid.<\/p>\n\n\n\n<\/figure>\n\n\n\nSubscription Product Experience<\/strong><\/p>\n\n\n\nWhen a product is assigned a subscription plan, customers see a purchase option selector on the product page and in the cart. <\/p>\n\n\n\n
They can choose between a one-time purchase and subscribing to the product with the selected billing frequency.<\/p>\n\n\n\n<\/figure>\n\n\n\n\n- On the product page, a subscription selector appears below the price showing ‘One-time purchase’ (standard pricing) and ‘Subscribe’ (recurring with the plan’s interval phrase, e.g. ‘Same price, every month’).<\/li>\n\n\n\n
- In the cart, a badge ‘Subscription product’ appears next to assigned products.<\/li>\n<\/ul>\n\n\n\n
<\/figure>\n\n\n\n\n- Cart conflict handling: if a customer tries to add a subscription product while another subscription product is already in the cart, a warning will display ‘Only one subscription product can be purchased in a single checkout.’<\/li>\n<\/ul>\n\n\n\n
<\/figure>\n\n\n\n\n- If a customer tries to mix subscription and non-subscription products in the same cart, the subscription product will block and an error message will display at the top of the cart.<\/li>\n<\/ul>\n\n\n\n
<\/figure>\n\n\n\nCustomer Subscription Management Page<\/strong><\/h3>\n\n\n\nLogged-in customers can access their subscriptions via the ‘My Subscription’ link in their account navigation. This page lists all subscriptions associated with the customer’s account.<\/p>\n\n\n\n<\/figure>\n\n\n\n\n- The list shows: subscription ID, status, subscription code, Airwallex subscription ID, payment source ID, next billing date, and action buttons (View and Cancel).<\/li>\n\n\n\n
- Clicking ‘View’ opens the subscription detail page showing full billing information, period dates, payment history, and a cancel button.<\/li>\n<\/ul>\n\n\n\n
<\/figure>\n\n\n\n\n- Clicking ‘Cancel’ prompts for confirmation. If confirmed, the subscription will be cancel at Airwallex and the local record will update.<\/li>\n\n\n\n
- Cancelled subscriptions display a ‘Cancelled’ label instead of the cancel button.<\/li>\n<\/ul>\n\n\n\n
Support<\/h3>\n\n\n\n
For any kind of technical assistance or query, please raise a ticket<\/a> or send us a mail at support@webkul.com<\/strong><\/p>\n\n\n\nAlso, please explore our Prestashop development services<\/a> and vast range of quality Prestashop addons<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"
<\/figure>\n\n\n\n<\/figure>\n\n\n\n<\/figure>\n\n\n\nHow to Create an Airwallex Account and Get API Keys<\/strong><\/h3>\n<\/div><\/div>\n\n\n\nStep 1 \u2014 Create an Account<\/strong><\/h4>\n\n\n\nNavigate to https:\/\/www.airwallex.com\/ and sign up for an Airwallex account. If you already have an account, log in to the Airwallex Dashboard.<\/p>\n\n\n\n
Step 2 \u2014 Find Your Billing Legal Entity ID<\/strong><\/p>\n\n\n\nIn the Airwallex Dashboard, go to Settings \u2192 Entities. Copy the Legal entity ID and paste it into the module’s configuration page.<\/p>\n\n\n\n
Step 3 \u2014 Find Your Linked Payment Account ID<\/strong><\/p>\n\n\n\nIn the Airwallex Dashboard, select to Account.<\/p>\n\n\n\n<\/figure>\n\n\n\nThen go to the “Accounts” section and click on the account.<\/p>\n\n\n\n<\/figure>\n\n\n\nThen copy the Linked Payment Account ID and paste it to the module configuration page.<\/p>\n\n\n\n<\/figure>\n\n\n\nStep 4 \u2014 Find Your Admin Client ID API Credentials<\/strong><\/h4>\n\n\n\nIn the Airwallex Dashboard, go to Developers \u2192 API keys \u2192 Admin keys. Copy the Client ID and paste it into the module’s configuration page.<\/p>\n\n\n\n<\/figure>\n\n\n\nStep 5 \u2014 Find Your Admin API Credentials<\/strong><\/p>\n\n\n\nIn the Airwallex Dashboard, go to Developers \u2192 API keys \u2192 Admin keys \u2192 click on the 3 dots \u2192 click on “Regenerate” and enter the account password.<\/p>\n\n\n\n<\/figure>\n\n\n\n<\/figure>\n\n\n\nCopy the API key and paste it to the module configuration field.<\/p>\n\n\n\n
Step 5 \u2014 Generate Webhook secret<\/strong><\/p>\n\n\n\nIn the Airwallex Dashboard, go to Developers \u2192 Webhooks \u2192 Add New webhook.<\/p>\n\n\n\n<\/figure>\n\n\n\nNow, enter the required fields, select the account, grant event permissions and click on “Create” button.<\/p>\n\n\n\n<\/figure>\n\n\n\nCopy the newly generated webhook API secret and paste it to the module configuration page. <\/p>\n\n\n\n<\/figure>\n\n\n\n\nPrestaShop Airwallex Payments Module Configuration<\/strong><\/h3>\n<\/div><\/div>\n\n\n\nNavigate to: Modules \u2192 Module Manager \u2192 Airwallex Payments Pro \u2192 Configure.<\/p>\n\n\n\n<\/figure>\n\n\n\nEnvironment<\/strong><\/h4>\n\n\n\nSelect whether the module should communicate with the Airwallex Demo (Sandbox) or Production (live) environment. This determines which set of API credentials is used.<\/p>\n\n\n\n
\n- Demo (Sandbox): Use for testing payments without real charges.<\/li>\n\n\n\n
- Production: Use for live transactions with real money.<\/li>\n<\/ul>\n\n\n\n
Payment through hosted payment page<\/strong><\/h4>\n\n\n\nChoose the checkout mode for your store.<\/p>\n\n\n\n
\n- Yes:<\/strong> Customers will redirect to the Airwallex hosted checkout page to complete payment.<\/li>\n\n\n\n
- No:<\/strong> An inline card form appears directly on the PrestaShop checkout page.<\/li>\n<\/ul>\n\n\n\n
Billing legal entity ID<\/strong><\/h4>\n\n\n\nPaste your Airwallex billing legal entity ID here. This is required when ‘Payment through hosted payment page’ is set to Yes, and is also required for subscription checkouts.<\/p>\n\n\n\n
Linked payment account ID<\/strong><\/h4>\n\n\n\nPaste your Airwallex linked payment account ID here. This is required when ‘Payment through hosted payment page’ is set to Yes, and is also required for subscription checkouts.<\/p>\n\n\n\n
Client ID<\/strong><\/h4>\n\n\n\nEnter your Airwallex Client ID for the currently selected environment. The module validates this credential on save by making a test API call to Airwallex.<\/p>\n\n\n\n
API key<\/strong><\/p>\n\n\n\nEnter your Airwallex API key for the currently selected environment. The module validates this credential on save by making a test API call to Airwallex.<\/p>\n\n\n\n
Webhook status<\/strong><\/p>\n\n\n\nDisplays the current webhook registration status. After saving valid credentials, the module automatically registers the webhook endpoint with Airwallex and stores the signing secret.<\/p>\n\n\n\n
Webhook URL<\/strong><\/h4>\n\n\n\nThe URL Airwallex sends webhook events to. This will generate automatically based on your store domain and cannot be edited.<\/p>\n\n\n\n
Webhook secret<\/strong><\/h4>\n\n\n\nEnter the webhook signing secret provided by Airwallex. This is used to validate that incoming webhook requests actually originate from Airwallex.<\/p>\n\n\n\n
Validate and save<\/strong><\/h4>\n\n\n\nClick this button to validate your Airwallex credentials, save all configuration values, store the webhook secret, and register the webhook endpoint with Airwallex.<\/p>\n\n\n\n
\n- On success:<\/strong> displays a confirmation message and updates the connection status to ‘Connected’.<\/li>\n\n\n\n
- On failure:<\/strong> displays validation errors if credentials are invalid or fields are missing.<\/li>\n<\/ul>\n\n\n\n
Re-register webhook<\/strong><\/h4>\n\n\n\nClick this button to re-register the webhook endpoint with Airwallex without re-saving all credentials. Useful if the webhook deletes or needs to refresh.<\/p>\n\n\n\n
\n- On success:<\/strong> displays a confirmation message and updates the webhook status to ‘Webhook active’.<\/li>\n\n\n\n
- On failure:<\/strong> displays an error if the webhook secret is missing or the registration fails.<\/li>\n<\/ul>\n\n\n\n
After entering all settings, click Save to apply the configuration.<\/p>\n\n\n\n
\nManaging Airwallex Payments from the Admin Panel<\/strong><\/h3>\n<\/div><\/div>\n\n\n\nAirwallex Payments Menu<\/strong><\/p>\n\n\n\nAfter installation, the module adds the following four submenu options under the ‘Airwallex’ menu option: <\/p>\n\n\n\n
\n- Transactions<\/li>\n\n\n\n
- Subscription plans <\/li>\n\n\n\n
- Plan products<\/li>\n\n\n\n
- Subscriptions<\/li>\n<\/ul>\n\n\n\n
Transactions<\/strong><\/h3>\n\n\n\nThe Transactions panel lists all payment records stored by the module. The admin can filter the list by intent ID, checkout ID, subscription ID, status, order, and date.<\/p>\n\n\n\n<\/figure>\n\n\n\nEach row shows: ID, Intent ID, Checkout ID, Subscription ID, Status, Order amount, Refunded amount, Order, and Date. Click the ‘view’ icon on any row to open the transaction detail page.<\/p>\n\n\n\n
The detail page shows: <\/p>\n\n\n\n
\n- Transaction reference<\/li>\n\n\n\n
- Airwallex intent ID<\/li>\n\n\n\n
- Airwallex checkout ID <\/li>\n\n\n\n
- Airwallex payment ID <\/li>\n\n\n\n
- Status<\/li>\n\n\n\n
- Order amount<\/li>\n\n\n\n
- Settlement amount<\/li>\n\n\n\n
- Captured amount<\/li>\n\n\n\n
- Refunded amount<\/li>\n\n\n\n
- Refund panel<\/li>\n<\/ul>\n\n\n\n
<\/figure>\n\n\n\n\n- The refund panel supports full refunds (one-click) and partial refunds.<\/li>\n<\/ul>\n\n\n\n
<\/figure>\n\n\n\n\n- The detail page also shows a refund history table with refund reference, Airwallex refund ID, amount, credit slip link, and creation date.<\/li>\n<\/ul>\n\n\n\n
<\/figure>\n\n\n\n\n- Status options in the filter: Created, Authorized, Captured, Partially refunded, Refunded.<\/li>\n<\/ul>\n\n\n\n
Subscription plans<\/strong><\/h3>\n\n\n\nThe Subscription plans panel lets you create and manage recurring billing plans.<\/p>\n\n\n\n<\/figure>\n\n\n\n\n- Each row shows:<\/strong> ID, Plan name, Frequency, Frequency interval, Cycles, Status, and Update date.<\/li>\n\n\n\n
- Click ‘edit<\/strong>‘ on a row to open the plan edit form, or use the ‘Add new plan’ header button to create a plan.<\/li>\n\n\n\n
- Bulk actions: <\/strong>delete selected plans (plans in use cannot be deleted).<\/li>\n\n\n\n
- Status can be toggled inline \u2014 yes\/no switch updates the active flag for the current shop context.<\/li>\n<\/ul>\n\n\n\n
Create Subscription Plan Form<\/strong><\/p>\n\n\n\n<\/figure>\n\n\n\n\n- Plan name:<\/strong> The name shown to customers and in the admin.<\/li>\n\n\n\n
- Frequency:<\/strong> Day, Week, Month, or Year.<\/li>\n\n\n\n
- Frequency interval:<\/strong> The number of frequency units between billings. Allowed ranges: day 1-365, week 1-52, month 1-12, year 1-100.<\/li>\n\n\n\n
- Cycles:<\/strong> Number of billing cycles. Set 0 for unlimited.<\/li>\n\n\n\n
- Status:<\/strong> Active (Yes) or inactive (No).<\/li>\n\n\n\n
- Save button:<\/strong> saves and returns to the list.<\/li>\n\n\n\n
- Save and stay button:<\/strong> saves and keeps the form open for further edits.<\/li>\n\n\n\n
- Back to list button:<\/strong> returns to the list without saving.<\/li>\n<\/ul>\n\n\n\n
Plan products<\/strong><\/h3>\n\n\n\nThe Plan products panel manages the assignment of subscription plans to products. Assignments link a plan to a specific product or product combination.<\/p>\n\n\n\n<\/figure>\n\n\n\n\n- Each row shows: ID, Plan name, Product ID, Product name (with combination attributes), Preview\/View, and Update date.<\/li>\n\n\n\n
- The ‘Preview\/View’ column links to the front-office product page for the assigned product.<\/li>\n\n\n\n
- Click ‘add’ or use the ‘Add plan product’ header button to open the assignment form.<\/li>\n\n\n\n
- Bulk delete: remove selected assignments.<\/li>\n<\/ul>\n\n\n\n
Assign Subscription Plan to Products<\/strong><\/h4>\n\n\n\n<\/figure>\n\n\n\n\n- Product search<\/strong>: type to search and select a product from your catalog.<\/li>\n\n\n\n
- Plan selection<\/strong>: choose which subscription plan to assign.<\/li>\n\n\n\n
- All combinations checkbox<\/strong>: if checked, the plan applies to all combinations of the product.<\/li>\n\n\n\n
- Specific combinations<\/strong>: select which combinations the plan applies to (only shown when ‘All combinations’ is unchecked).<\/li>\n\n\n\n
- Submit<\/strong>: saves the assignment and returns to the list.<\/li>\n<\/ul>\n\n\n\n
Note<\/strong>: A product can only be assigned to one plan at a time.<\/p>\n\n\n\nSubscriptions<\/strong><\/p>\n\n\n\nThe Subscriptions panel lists every subscription record created through the module. Subscriptions are listed per the current shop context.<\/p>\n\n\n\n<\/figure>\n\n\n\n\n- Each row shows<\/strong>: ID, Subscription code, Plan name, Airwallex subscription ID, Billing customer ID, Payment source ID, Status, Last order, and Shop (all-shops context only).<\/li>\n\n\n\n
- Status options<\/strong>: Active, Pending, Cancelled.<\/li>\n\n\n\n
- Click ‘view<\/strong>‘ on a row to open the subscription detail page.<\/li>\n\n\n\n
- Click the ‘Cancel<\/strong>‘ action icon to cancel an active subscription \u2014 this sends a cancellation request to Airwallex and updates the local record.<\/li>\n<\/ul>\n\n\n\n
<\/figure>\n\n\n\nThe subscription detail page shows: status, plan name, billing frequency, amount, billing date, start\/end period, cancelled at, last order, created at, updated at, and a transaction history table.<\/p>\n\n\n\n
The transaction history table in the subscription view shows each transaction’s reference, type (initial\/recurring), status, amount, associated order (with link), and date.<\/p>\n\n\n\n
\n- The ‘Back to list’ button returns to the subscriptions list.<\/li>\n<\/ul>\n\n\n\n\n
Storefront Experience<\/strong><\/h3>\n<\/div><\/div>\n\n\n\nWhen a customer proceeds to checkout, the Airwallex payment option appears on the payment selection step. <\/p>\n\n\n\n
The option is labeled ‘Pay by Airwallex payment’. The behavior depends on the configured checkout mode.<\/p>\n\n\n\n
Hosted Checkout Mode<\/strong><\/h3>\n\n\n\nWhen ‘Payment through hosted payment page’ is set to Yes, clicking the Airwallex payment option redirects the customer to Airwallex’s secure hosted checkout page.<\/p>\n\n\n\n<\/figure>\n\n\n\n<\/figure>\n\n\n\nThe page displays the order total, currency, and line items. After successful payment, the customer is redirected back to your store’s order confirmation page.<\/p>\n\n\n\n<\/figure>\n\n\n\nEmbedded Checkout Mode<\/strong><\/h3>\n\n\n\nWhen ‘Payment through hosted payment page’ is set to “No”. An inline card form is rendered on the checkout page using the Airwallex JavaScript SDK. <\/p>\n\n\n\n
Customers enter their card number, expiry date, and CVC directly in a secure field hosted by Airwallex. <\/p>\n\n\n\n
Real-time validation indicates whether the card number, expiry, and CVC are valid.<\/p>\n\n\n\n<\/figure>\n\n\n\nSubscription Product Experience<\/strong><\/p>\n\n\n\nWhen a product is assigned a subscription plan, customers see a purchase option selector on the product page and in the cart. <\/p>\n\n\n\n
They can choose between a one-time purchase and subscribing to the product with the selected billing frequency.<\/p>\n\n\n\n<\/figure>\n\n\n\n\n- On the product page, a subscription selector appears below the price showing ‘One-time purchase’ (standard pricing) and ‘Subscribe’ (recurring with the plan’s interval phrase, e.g. ‘Same price, every month’).<\/li>\n\n\n\n
- In the cart, a badge ‘Subscription product’ appears next to assigned products.<\/li>\n<\/ul>\n\n\n\n
<\/figure>\n\n\n\n\n- Cart conflict handling: if a customer tries to add a subscription product while another subscription product is already in the cart, a warning will display ‘Only one subscription product can be purchased in a single checkout.’<\/li>\n<\/ul>\n\n\n\n
<\/figure>\n\n\n\n\n- If a customer tries to mix subscription and non-subscription products in the same cart, the subscription product will block and an error message will display at the top of the cart.<\/li>\n<\/ul>\n\n\n\n
<\/figure>\n\n\n\nCustomer Subscription Management Page<\/strong><\/h3>\n\n\n\nLogged-in customers can access their subscriptions via the ‘My Subscription’ link in their account navigation. This page lists all subscriptions associated with the customer’s account.<\/p>\n\n\n\n<\/figure>\n\n\n\n\n- The list shows: subscription ID, status, subscription code, Airwallex subscription ID, payment source ID, next billing date, and action buttons (View and Cancel).<\/li>\n\n\n\n
- Clicking ‘View’ opens the subscription detail page showing full billing information, period dates, payment history, and a cancel button.<\/li>\n<\/ul>\n\n\n\n
<\/figure>\n\n\n\n\n- Clicking ‘Cancel’ prompts for confirmation. If confirmed, the subscription will be cancel at Airwallex and the local record will update.<\/li>\n\n\n\n
- Cancelled subscriptions display a ‘Cancelled’ label instead of the cancel button.<\/li>\n<\/ul>\n\n\n\n
Support<\/h3>\n\n\n\n
For any kind of technical assistance or query, please raise a ticket<\/a> or send us a mail at support@webkul.com<\/strong><\/p>\n\n\n\nAlso, please explore our Prestashop development services<\/a> and vast range of quality Prestashop addons<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"
Navigate to https:\/\/www.airwallex.com\/ and sign up for an Airwallex account. If you already have an account, log in to the Airwallex Dashboard.<\/p>\n\n\n\n
Step 2 \u2014 Find Your Billing Legal Entity ID<\/strong><\/p>\n\n\n\n In the Airwallex Dashboard, go to Settings \u2192 Entities. Copy the Legal entity ID and paste it into the module’s configuration page.<\/p>\n\n\n\n Step 3 \u2014 Find Your Linked Payment Account ID<\/strong><\/p>\n\n\n\n In the Airwallex Dashboard, select to Account.<\/p>\n\n\n\n Then go to the “Accounts” section and click on the account.<\/p>\n\n\n\n Then copy the Linked Payment Account ID and paste it to the module configuration page.<\/p>\n\n\n\n In the Airwallex Dashboard, go to Developers \u2192 API keys \u2192 Admin keys. Copy the Client ID and paste it into the module’s configuration page.<\/p>\n\n\n\n Step 5 \u2014 Find Your Admin API Credentials<\/strong><\/p>\n\n\n\n In the Airwallex Dashboard, go to Developers \u2192 API keys \u2192 Admin keys \u2192 click on the 3 dots \u2192 click on “Regenerate” and enter the account password.<\/p>\n\n\n\n Copy the API key and paste it to the module configuration field.<\/p>\n\n\n\n Step 5 \u2014 Generate Webhook secret<\/strong><\/p>\n\n\n\n In the Airwallex Dashboard, go to Developers \u2192 Webhooks \u2192 Add New webhook.<\/p>\n\n\n\n Now, enter the required fields, select the account, grant event permissions and click on “Create” button.<\/p>\n\n\n\n Copy the newly generated webhook API secret and paste it to the module configuration page. <\/p>\n\n\n\n Navigate to: Modules \u2192 Module Manager \u2192 Airwallex Payments Pro \u2192 Configure.<\/p>\n\n\n\n Select whether the module should communicate with the Airwallex Demo (Sandbox) or Production (live) environment. This determines which set of API credentials is used.<\/p>\n\n\n\n Choose the checkout mode for your store.<\/p>\n\n\n\n Paste your Airwallex billing legal entity ID here. This is required when ‘Payment through hosted payment page’ is set to Yes, and is also required for subscription checkouts.<\/p>\n\n\n\n Paste your Airwallex linked payment account ID here. This is required when ‘Payment through hosted payment page’ is set to Yes, and is also required for subscription checkouts.<\/p>\n\n\n\n Enter your Airwallex Client ID for the currently selected environment. The module validates this credential on save by making a test API call to Airwallex.<\/p>\n\n\n\n API key<\/strong><\/p>\n\n\n\n Enter your Airwallex API key for the currently selected environment. The module validates this credential on save by making a test API call to Airwallex.<\/p>\n\n\n\n Webhook status<\/strong><\/p>\n\n\n\n Displays the current webhook registration status. After saving valid credentials, the module automatically registers the webhook endpoint with Airwallex and stores the signing secret.<\/p>\n\n\n\n The URL Airwallex sends webhook events to. This will generate automatically based on your store domain and cannot be edited.<\/p>\n\n\n\n Enter the webhook signing secret provided by Airwallex. This is used to validate that incoming webhook requests actually originate from Airwallex.<\/p>\n\n\n\n Click this button to validate your Airwallex credentials, save all configuration values, store the webhook secret, and register the webhook endpoint with Airwallex.<\/p>\n\n\n\n Click this button to re-register the webhook endpoint with Airwallex without re-saving all credentials. Useful if the webhook deletes or needs to refresh.<\/p>\n\n\n\n After entering all settings, click Save to apply the configuration.<\/p>\n\n\n\n Airwallex Payments Menu<\/strong><\/p>\n\n\n\n After installation, the module adds the following four submenu options under the ‘Airwallex’ menu option: <\/p>\n\n\n\n The Transactions panel lists all payment records stored by the module. The admin can filter the list by intent ID, checkout ID, subscription ID, status, order, and date.<\/p>\n\n\n\n Each row shows: ID, Intent ID, Checkout ID, Subscription ID, Status, Order amount, Refunded amount, Order, and Date. Click the ‘view’ icon on any row to open the transaction detail page.<\/p>\n\n\n\n The detail page shows: <\/p>\n\n\n\n The Subscription plans panel lets you create and manage recurring billing plans.<\/p>\n\n\n\n Create Subscription Plan Form<\/strong><\/p>\n\n\n\n The Plan products panel manages the assignment of subscription plans to products. Assignments link a plan to a specific product or product combination.<\/p>\n\n\n\n Note<\/strong>: A product can only be assigned to one plan at a time.<\/p>\n\n\n\n Subscriptions<\/strong><\/p>\n\n\n\n The Subscriptions panel lists every subscription record created through the module. Subscriptions are listed per the current shop context.<\/p>\n\n\n\n The subscription detail page shows: status, plan name, billing frequency, amount, billing date, start\/end period, cancelled at, last order, created at, updated at, and a transaction history table.<\/p>\n\n\n\n The transaction history table in the subscription view shows each transaction’s reference, type (initial\/recurring), status, amount, associated order (with link), and date.<\/p>\n\n\n\n When a customer proceeds to checkout, the Airwallex payment option appears on the payment selection step. <\/p>\n\n\n\n The option is labeled ‘Pay by Airwallex payment’. The behavior depends on the configured checkout mode.<\/p>\n\n\n\n When ‘Payment through hosted payment page’ is set to Yes, clicking the Airwallex payment option redirects the customer to Airwallex’s secure hosted checkout page.<\/p>\n\n\n\n The page displays the order total, currency, and line items. After successful payment, the customer is redirected back to your store’s order confirmation page.<\/p>\n\n\n\n When ‘Payment through hosted payment page’ is set to “No”. An inline card form is rendered on the checkout page using the Airwallex JavaScript SDK. <\/p>\n\n\n\n Customers enter their card number, expiry date, and CVC directly in a secure field hosted by Airwallex. <\/p>\n\n\n\n Real-time validation indicates whether the card number, expiry, and CVC are valid.<\/p>\n\n\n\n Subscription Product Experience<\/strong><\/p>\n\n\n\n When a product is assigned a subscription plan, customers see a purchase option selector on the product page and in the cart. <\/p>\n\n\n\n They can choose between a one-time purchase and subscribing to the product with the selected billing frequency.<\/p>\n\n\n\n Logged-in customers can access their subscriptions via the ‘My Subscription’ link in their account navigation. This page lists all subscriptions associated with the customer’s account.<\/p>\n\n\n\n For any kind of technical assistance or query, please raise a ticket<\/a> or send us a mail at support@webkul.com<\/strong><\/p>\n\n\n\n Also, please explore our Prestashop development services<\/a> and vast range of quality Prestashop addons<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"<\/figure>\n\n\n\n<\/figure>\n\n\n\n<\/figure>\n\n\n\nStep 4 \u2014 Find Your Admin Client ID API Credentials<\/strong><\/h4>\n\n\n\n
<\/figure>\n\n\n\n<\/figure>\n\n\n\n<\/figure>\n\n\n\n<\/figure>\n\n\n\n<\/figure>\n\n\n\n<\/figure>\n\n\n\nPrestaShop Airwallex Payments Module Configuration<\/strong><\/h3>\n<\/div><\/div>\n\n\n\n
<\/figure>\n\n\n\nEnvironment<\/strong><\/h4>\n\n\n\n
\n
Payment through hosted payment page<\/strong><\/h4>\n\n\n\n
\n
Billing legal entity ID<\/strong><\/h4>\n\n\n\n
Linked payment account ID<\/strong><\/h4>\n\n\n\n
Client ID<\/strong><\/h4>\n\n\n\n
Webhook URL<\/strong><\/h4>\n\n\n\n
Webhook secret<\/strong><\/h4>\n\n\n\n
Validate and save<\/strong><\/h4>\n\n\n\n
\n
Re-register webhook<\/strong><\/h4>\n\n\n\n
\n
Managing Airwallex Payments from the Admin Panel<\/strong><\/h3>\n<\/div><\/div>\n\n\n\n
\n
Transactions<\/strong><\/h3>\n\n\n\n
<\/figure>\n\n\n\n\n
<\/figure>\n\n\n\n\n
<\/figure>\n\n\n\n\n
<\/figure>\n\n\n\n\n
Subscription plans<\/strong><\/h3>\n\n\n\n
<\/figure>\n\n\n\n\n
<\/figure>\n\n\n\n\n
Plan products<\/strong><\/h3>\n\n\n\n
<\/figure>\n\n\n\n\n
Assign Subscription Plan to Products<\/strong><\/h4>\n\n\n\n
<\/figure>\n\n\n\n\n
<\/figure>\n\n\n\n\n
<\/figure>\n\n\n\n\n
Storefront Experience<\/strong><\/h3>\n<\/div><\/div>\n\n\n\n
Hosted Checkout Mode<\/strong><\/h3>\n\n\n\n
<\/figure>\n\n\n\n<\/figure>\n\n\n\n<\/figure>\n\n\n\nEmbedded Checkout Mode<\/strong><\/h3>\n\n\n\n
<\/figure>\n\n\n\n<\/figure>\n\n\n\n\n
<\/figure>\n\n\n\n\n
<\/figure>\n\n\n\n\n
<\/figure>\n\n\n\nCustomer Subscription Management Page<\/strong><\/h3>\n\n\n\n
<\/figure>\n\n\n\n\n
<\/figure>\n\n\n\n\n
Support<\/h3>\n\n\n\n