Required
| Requirement | Version | Why |
|---|---|---|
| PHP | 8.3+ | |
ext-openssl |
any | Local webhook signature verification |
Laravel (illuminate/support, illuminate/http) |
12 or 13 | |
artisanpack-ui/ecommerce |
1.3+ (^1.3) |
The PaymentGateway and RendersClientPayment contracts, the registries, and the settings screen, plus what engine 1.3 added: SharesWebhookEndpoint (one webhook URL for the four gateways), AcceptsPaymentOptions (the save and saved-card choices), RefundService::recordProviderRefund() (recording refunds made in PayPal, and settling a store refund recorded as failed that PayPal completed), and PaymentOrchestrator::recordProviderPaymentFailure() (failing a payment whose pending capture PayPal denied) |
artisanpack-ui/core |
1.0+ | Ecosystem baseline |
artisanpack-ui/hooks |
1.2+ | The actions and filters |
moneyphp/money |
4.1+ | Amounts (the engine uses it too) |
The engine's REST stack (Sanctum) is only needed for the saved payment methods REST endpoints.
Optional
These are detected at runtime. Install them for the parts you need:
| Package | Enables |
|---|---|
artisanpack-ui/ecommerce-storefront-livewire |
The Livewire payment drivers, the saved payment methods account page, and the live Pay Later message that follows the cart total |
artisanpack-ui/ecommerce-admin-livewire |
The PayPal order panel and the store settings screen |
livewire/livewire |
Required by both of the above (they pull it in). On its own it enables the live Pay Later message component |
Without a storefront package, only the engine-side code loads: the gateways, webhooks, commands, and REST endpoints. React and Vue storefronts use the JavaScript module and the REST endpoints.
Front end
The package ships no CSS build. Its views use Tailwind CSS 4 and daisyUI 5 class names, compiled by your application, like the storefront. The JS module ships prebuilt in dist/, so you need no Node toolchain. See Front-End Setup.
PayPal account
- A PayPal developer account, for sandbox apps and test buyers.
- A PayPal Business account for live payments.
- For card fields, Apple Pay, and Google Pay, the live account must be approved for advanced credit and debit card payments and the wallet features. See PayPal App and Credentials.
Hosting
- HTTPS in production. Live webhooks must use HTTPS (
ecommerce-paypal:webhooks:registerrefuses anhttpURL in live mode), and Apple Pay only works over HTTPS. - A public URL for PayPal's webhooks. During local development use a tunnel.
- A queue worker. Webhook side effects run as queued jobs on the engine's webhook queue (
artisanpack.ecommerce.webhooks.connection/.queue). - The scheduler.
ecommerce-paypal:authorizations:reauthorizeandecommerce-paypal:prune-vaultare scheduled daily. Runphp artisan schedule:work(or a cron entry forschedule:run), especially if you use theauthorizeintent or saved payment methods.