PHPackages djlemmor/djpaykit-laravel - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. djlemmor/djpaykit-laravel ActiveLibrary djlemmor/djpaykit-laravel ========================= Laravel backend adapter for the DJPayKit QR payment widget. v0.1.0(today)00MITPHPPHP ^8.2 Since Aug 25Pushed todayCompare [ Source](https://github.com/djlemmor/dj-paykit-laravel)[ Packagist](https://packagist.org/packages/djlemmor/djpaykit-laravel)[ Docs](https://github.com/djlemmor/dj-paykit-laravel)[ RSS](/packages/djlemmor-djpaykit-laravel/feed)WikiDiscussions main Synced today READMEChangelog (1)Dependencies (8)Versions (2)Used By (0) DJPayKit Laravel ================ [](#djpaykit-laravel) Laravel 12 backend adapter for the DJPayKit QR payment widget. It allows a website owner to configure payment methods such as GCash, Maya, and MariBank, upload private QR images, and expose controlled public endpoints for the DJPayKit widget. Requirements ------------ [](#requirements) - PHP 8.2 or newer - Laravel 12 - A Laravel filesystem disk - Authentication middleware for administrator endpoints Features -------- [](#features) - GCash, Maya, and MariBank support - Extensible provider configuration - Private QR image storage - Public payment-method API - Controlled QR image responses - Administrator CRUD endpoints - Account-number privacy controls - ULID payment-method identifiers - Soft deletion - Validated PNG, JPEG, and WebP uploads - Safe QR replacement and cleanup - Automated package tests Installation ------------ [](#installation) The package has not yet been published to Packagist. The standard installation command will become available after the first release: ``` composer require djlemmor/djpaykit-laravel ``` Then run: ``` # Publishes the configuration and database migration. php artisan djpaykit:install # Creates the DJPayKit database table. php artisan migrate ``` Local development installation ------------------------------ [](#local-development-installation) Add DJPayKit as a Composer path repository: ``` # Registers the local Laravel adapter. composer config repositories.djpaykit path ../DJPayKit/packages/laravel # Installs the development version. composer require djlemmor/djpaykit-laravel:@dev ``` Run the installer: ``` php artisan djpaykit:install php artisan migrate ``` Composer normally symlinks the package, so local DJPayKit changes become available without reinstalling it. Configuration ------------- [](#configuration) The installation command publishes: ``` config/djpaykit.php ``` Important settings: SettingDefaultPurpose`route_prefix``api/djpaykit`Prefix for all package routes`api_middleware``['api']`Middleware for public widget routes`admin_middleware``['api', 'auth']`Middleware for administrator routes`storage_disk``local`Private QR and receipt storage`maximum_image_size_kb``5120`Maximum upload size in kilobytes`maximum_image_width``4096`Maximum QR width`maximum_image_height``4096`Maximum QR height`default_currency``PHP`Default payment currency`show_account_number_by_default``false`Default public account-number visibility`proof_of_payment_enabled``false`Enables future receipt submissionsEnvironment variables: ``` DJPAYKIT_ROUTE_PREFIX=api/djpaykit DJPAYKIT_STORAGE_DISK=local DJPAYKIT_PROOF_OF_PAYMENT_ENABLED=false ``` Administrator authentication ---------------------------- [](#administrator-authentication) Administrator endpoints use the middleware configured in: ``` 'admin_middleware' => ['api', 'auth'], ``` Applications using Sanctum can change it to: ``` /* * Requires an authenticated Sanctum user for administrator actions. */ 'admin_middleware' => ['api', 'auth:sanctum'], ``` DJPayKit does not create administrator users or decide which users are authorized. The host Laravel application remains responsible for authentication and authorization. Storage security ---------------- [](#storage-security) QR images use Laravel's configured private disk: ``` 'storage_disk' => 'local', ``` Laravel 12's local disk normally stores private files below: ``` storage/app/private ``` DJPayKit serves QR images through a controlled route. It never returns the underlying filesystem or cloud-storage path. Do not move DJPayKit QR images to the public disk unless your application intentionally wants to bypass these controls. Supported providers ------------------- [](#supported-providers) The default providers are: ``` 'providers' => [ 'gcash' => [ 'display_name' => 'GCash', ], 'maya' => [ 'display_name' => 'Maya', ], 'maribank' => [ 'display_name' => 'MariBank', ], ], ``` A host application can add another provider: ``` /* * Adds another provider without changing the package source. */ 'providers' => [ // Existing providers... 'instapay' => [ 'display_name' => 'InstaPay', ], ], ``` Provider IDs may contain lowercase letters, numbers, hyphens, and underscores. Public API ---------- [](#public-api) ### List enabled payment methods [](#list-enabled-payment-methods) ``` GET /api/djpaykit/payment-methods ``` Example response: ``` { "data": [ { "id": "01m0wvqzdj7czkf04tjc8443k6", "provider": "gcash", "displayName": "GCash", "accountName": "DJ Business", "accountNumber": null, "qrImageUrl": "https://example.com/api/djpaykit/payment-methods/01m0wvqzdj7czkf04tjc8443k6/qr", "instructions": "Include your order number." } ] } ``` `accountNumber` is `null` unless the owner enables `show_account_number` for that payment method. Disabled and soft-deleted methods are excluded. ### Display a QR image [](#display-a-qr-image) ``` GET /api/djpaykit/payment-methods/{paymentMethod}/qr ``` The endpoint: - Only serves enabled payment methods - Reads from the configured private disk - Allows PNG, JPEG, and WebP - Sends `X-Content-Type-Options: nosniff` - Does not expose the private storage path - Returns `404` for disabled, deleted, missing, or unsupported images Administrator API ----------------- [](#administrator-api) All administrator routes require the configured administrator middleware. ### List payment methods [](#list-payment-methods) ``` GET /api/djpaykit/admin/payment-methods ``` The administrator list includes enabled and disabled methods but excludes soft-deleted records and private QR paths. ### Create a payment method [](#create-a-payment-method) ``` POST /api/djpaykit/admin/payment-methods Content-Type: multipart/form-data ``` Example using cURL: ``` # Replace TOKEN and the image path with actual values. curl -X POST "https://example.com/api/djpaykit/admin/payment-methods" \ -H "Accept: application/json" \ -H "Authorization: Bearer TOKEN" \ -F "provider=gcash" \ -F "display_name=GCash" \ -F "account_name=DJ Business" \ -F "account_number=0912 345 6789" \ -F "show_account_number=1" \ -F "is_enabled=1" \ -F "sort_order=10" \ -F "instructions=Include your order number." \ -F "qr_image=@/absolute/path/gcash.png" ``` Required fields: - `provider` - `display_name` - `account_name` - `qr_image` Optional fields: - `account_number` - `instructions` - `show_account_number` - `is_enabled` - `sort_order` QR requirements: - PNG, JPEG, or WebP - Maximum 5 MB by default - Maximum 4096×4096 pixels by default - SVG is not accepted ### Update a payment method [](#update-a-payment-method) ``` PATCH /api/djpaykit/admin/payment-methods/{paymentMethod} ``` All update fields are optional. The provider cannot be changed after creation. Example replacing a QR: ``` # Stores the replacement before removing the currently working QR. curl -X PATCH \ "https://example.com/api/djpaykit/admin/payment-methods/PAYMENT_METHOD_ID" \ -H "Accept: application/json" \ -H "Authorization: Bearer TOKEN" \ -F "account_name=Updated Business" \ -F "qr_image=@/absolute/path/new-gcash.png" ``` If the database update fails, DJPayKit deletes the new upload and keeps the original QR. ### Delete a payment method [](#delete-a-payment-method) ``` DELETE /api/djpaykit/admin/payment-methods/{paymentMethod} ``` Deletion: - Soft-deletes the database record - Removes the associated QR image - Prevents the public API from returning the method - Returns HTTP `204 No Content` Error responses --------------- [](#error-responses) Common status codes: StatusMeaning`200`Successful list or update`201`Payment method created`204`Payment method deleted`404`Payment method or QR not found`422`Validation failed`500`Unexpected storage or database failureLaravel returns validation errors in its normal JSON format: ``` { "message": "The given data was invalid.", "errors": { "provider": ["The selected provider is not supported by DJPayKit."] } } ``` Routes ------ [](#routes) List all package routes: ``` php artisan route:list --name=djpaykit ``` DJPayKit registers: ``` GET api/djpaykit/admin/payment-methods POST api/djpaykit/admin/payment-methods PATCH api/djpaykit/admin/payment-methods/{paymentMethod} DELETE api/djpaykit/admin/payment-methods/{paymentMethod} GET api/djpaykit/payment-methods GET api/djpaykit/payment-methods/{paymentMethod}/qr ``` Frontend widget integration --------------------------- [](#frontend-widget-integration) Install the core widget after it is published: ``` npm install @djlemmor/djpaykit ``` For local development: ``` # Installs the core package directly from the DJPayKit repository. npm install ../DJPayKit/packages/core ``` Register the custom element in the application's JavaScript entry: ``` import { defineDJPayKitWidget } from "@djlemmor/djpaykit"; /* * Registers with the browser. */ defineDJPayKitWidget(); ``` Example Laravel Blade integration: ``` {{-- Vite loads the JavaScript that registers the widget. --}} @vite('resources/js/app.js') ``` The first enabled method is selected automatically. Selecting another provider updates its account details and QR without reloading the page. ### Widget events [](#widget-events) The host checkout can observe provider selection: ``` document.addEventListener("djpaykit:provider-selected", (event) => { /* * detail contains paymentMethodId and provider. * It does not expose the account number. */ console.log(event.detail); }); ``` The host checkout can also observe successful QR downloads: ``` document.addEventListener("djpaykit:qr-downloaded", (event) => { /* * detail contains paymentMethodId and provider. */ console.log(event.detail); }); ``` For the simplest integration, serve the Laravel API and widget from the same origin. Cross-origin integrations require the host application's CORS configuration to allow the checkout website. Package development ------------------- [](#package-development) Install dependencies: ``` composer install ``` Run tests: ``` composer test ``` Run a specific test: ``` vendor/bin/phpunit tests/Feature/PublicPaymentMethodEndpointTest.php ``` On Windows, if Git Bash cannot run the Unix vendor launcher, use: ``` composer exec -- phpunit tests/Feature/PublicPaymentMethodEndpointTest.php ``` Current verified result: ``` Tests: 28 Assertions: 96 ``` License ------- [](#license) DJPayKit Laravel is open-source software licensed under the MIT License. ### Health Score 36 — LowBetter than 79% of packages Maintenance100 Actively maintained with recent releases Popularity0 Limited adoption so far Community6 Small or concentrated contributor base Maturity35 Early-stage or recently created project Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Unknown Total 1 Last Release 0d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/87967672?v=4)[DJ Lemmor Nuique](/maintainers/djlemmor)[@djlemmor](https://github.com/djlemmor) --- Top Contributors [![djlemmor](https://avatars.githubusercontent.com/u/87967672?v=4)](https://github.com/djlemmor "djlemmor (11 commits)") --- Tags qr codelaravelMayapaymentsphilippinesgcashmaribank ### Embed Badge ![Health badge](/badges/djlemmor-djpaykit-laravel/health.svg) ``` [![Health](https://phpackages.com/badges/djlemmor-djpaykit-laravel/health.svg)](https://phpackages.com/packages/djlemmor-djpaykit-laravel) ``` ### Alternatives [psalm/plugin-laravel Psalm plugin for Laravel 3345.4M354](/packages/psalm-plugin-laravel)[laravel/mcp Rapidly build MCP servers for your Laravel applications. 80427.1M249](/packages/laravel-mcp)[roots/acorn Framework for Roots WordPress projects built with Laravel components. 9922.4M147](/packages/roots-acorn)[aedart/athenaeum Athenaeum is a mono repository; a collection of various PHP packages 265.2k](/packages/aedart-athenaeum)[laravel/cashier Laravel Cashier provides an expressive, fluent interface to Stripe's subscription billing services. 2.5k31.8M163](/packages/laravel-cashier)[laravel/ai The official AI SDK for Laravel. 1.1k4.6M341](/packages/laravel-ai) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)