PHPackages quellabs/canvas-payments-adyen - 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. [Payment Processing](/categories/payments) 4. / 5. quellabs/canvas-payments-adyen ActiveLibrary[Payment Processing](/categories/payments) quellabs/canvas-payments-adyen ============================== Adyen payment gateway integration for the Canvas PHP framework 1.0.10(1mo ago)00MITPHPPHP ^8.2 Since Mar 19Pushed 2w agoCompare [ Source](https://github.com/quellabs/canvas-payments-adyen)[ Packagist](https://packagist.org/packages/quellabs/canvas-payments-adyen)[ RSS](/packages/quellabs-canvas-payments-adyen/feed)WikiDiscussions main Synced 3w ago READMEChangelogDependencies (12)Versions (12)Used By (0) Adyen Payment Provider ====================== [](#adyen-payment-provider) An Adyen payment provider for the Canvas framework. Part of the Canvas payments ecosystem. Installation ------------ [](#installation) ``` composer require quellabs/canvas-payments-adyen ``` Architecture ------------ [](#architecture) This package sits between the Adyen API and your application. Your application only ever touches the contracts layer — it never depends on this package directly. `PaymentRouter` (from `quellabs/canvas-payments`) discovers this package automatically via composer metadata and routes payment calls to it. ``` Your Application │ ▼ PaymentRouter (quellabs/canvas-payments — discovery + routing) │ ▼ PaymentInterface (quellabs/canvas-payments-contracts) │ ▼ Adyen (this package — implements the interface) │ ▼ AdyenGateway (raw Adyen API calls) ``` Notification processing is decoupled from your application via signals. When Adyen sends a notification, the package emits a `payment_exchange` signal carrying a `PaymentState`. Your application listens for that signal and handles it. Configuration ------------- [](#configuration) Create `config/adyen.php` in your Canvas application: ``` return [ 'test_mode' => true, 'api_key' => '', 'merchant_account' => '', 'hmac_key' => '', 'live_endpoint_prefix' => '', // required when test_mode is false 'return_url' => 'https://example.com/order/thankyou', 'cancel_return_url' => 'https://example.com/order/cancelled', 'webhook_url' => 'https://example.com/webhooks/adyen', 'default_country' => 'NL', 'default_currency' => 'EUR', ]; ``` KeyRequiredDescription`test_mode`NoEnable Adyen test environment. Defaults to `false``api_key`YesYour Adyen API key. Found in Customer Area under Developers → API credentials. Use a test credential when `test_mode` is `true``merchant_account`YesThe Adyen merchant account name (not the company account). Found next to the account switcher in Customer Area`hmac_key`YesHMAC key for verifying incoming webhook signatures. Generated per webhook under Developers → Webhooks → Edit webhook`live_endpoint_prefix`NoRequired when `test_mode` is `false`. Found in Customer Area under Developers → API URLs. Format: `-``return_url`YesURL the customer is redirected to after the package handles the return`cancel_return_url`YesURL the customer is redirected to after the package handles the cancel`webhook_url`YesFull URL Adyen POSTs webhook notifications to. Must be publicly reachable. Configure under Developers → Webhooks`default_country`NoISO 3166-1 alpha-2 country code used when calling `getPaymentOptions()` without a transaction context (e.g. `'NL'`)`default_currency`NoISO 4217 currency code used when calling `getPaymentOptions()` without a transaction context (e.g. `'EUR'`)Usage ----- [](#usage) ### Initiating a payment [](#initiating-a-payment) Inject `PaymentInterface` via Canvas DI and call `initiate()`: ``` use Quellabs\Payments\Contracts\PaymentInterface; use Quellabs\Canvas\Controllers\BaseController; use Quellabs\Payments\Contracts\PaymentRequest; use Quellabs\Payments\Contracts\PaymentInitiationException; class CheckoutController extends BaseController { public function __construct(private PaymentInterface $router) {} /** * @Route("...") */ public function checkout(): void { $request = new PaymentRequest( paymentModule: 'adyen_ideal', amount: 999, // in minor units — €9.99 currency: 'EUR', description: 'Order #12345', ); try { $result = $this->router->initiate($request); return $this->redirect($result->redirectUrl); } catch (PaymentInitiationException $e) { // handle error } } } ``` ### Handling refunds [](#handling-refunds) Adyen refunds reference the `pspReference` from the original payment, which is exposed as `transactionId` on `PaymentState`. No additional metadata needs to be persisted — the `transactionId` from your `payment_exchange`listener is sufficient. ``` use Quellabs\Payments\Contracts\RefundRequest; use Quellabs\Payments\Contracts\PaymentRefundException; // Full refund $request = new RefundRequest( paymentReference: $state->transactionId, paymentModule: 'adyen_ideal', amount: null, // null = full refund currency: 'EUR', description: 'Full refund for order #12345', ); // Partial refund $request = new RefundRequest( paymentReference: $state->transactionId, paymentModule: 'adyen_ideal', amount: 500, // in minor units — €5.00 currency: 'EUR', description: Partial refund for order #12345', ); try { $result = $this->router->refund($request); echo $result->refundId; } catch (PaymentRefundException $e) { // handle error } ``` Note: Adyen processes refunds asynchronously. The `refundId` in the result is a `pspReference` for the refund request itself. The final `REFUND` notification arrives separately and triggers a `payment_exchange` signal with `PaymentStatus::Refunded`. ### Listening for payment state changes [](#listening-for-payment-state-changes) ``` use Quellabs\Canvas\Annotations\ListenTo; use Quellabs\Payments\Contracts\PaymentState; use Quellabs\Payments\Contracts\PaymentStatus; class OrderService { /** * @ListenTo("payment_exchange") */ public function onPaymentExchange(PaymentState $state): void { match ($state->state) { PaymentStatus::Paid => $this->markPaid($state->transactionId, $state->valuePaid), PaymentStatus::Canceled => $this->markCanceled($state->transactionId), PaymentStatus::Expired => $this->markExpired($state->transactionId), PaymentStatus::Refunded => $this->handleRefund($state), default => null, }; } } ``` License ------- [](#license) MIT ### Health Score 40 — FairBetter than 86% of packages Maintenance95 Actively maintained with recent releases Popularity0 Limited adoption so far Community2 Small or concentrated contributor base Maturity53 Maturing project, gaining track record 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 Every ~6 days Recently: every ~13 days Total 11 Last Release 33d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/57e4ab872b3e37536367f2d26b192df3d3bb6a6a1cebec9a104d14a6d2ffe157?d=identicon)[noescom](/maintainers/noescom) --- Tags paymentscanvaspayment gatewayadyencanvas-payments ### Embed Badge ![Health badge](/badges/quellabs-canvas-payments-adyen/health.svg) ``` [![Health](https://phpackages.com/badges/quellabs-canvas-payments-adyen/health.svg)](https://phpackages.com/packages/quellabs-canvas-payments-adyen) ``` PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)