PHPackages quellabs/canvas-payments-paynl - 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-paynl ActiveLibrary[Payment Processing](/categories/payments) quellabs/canvas-payments-paynl ============================== Pay.nl payment gateway integration for the Canvas PHP framework 1.0.4(1mo ago)00MITPHPPHP ^8.2 Since Mar 20Pushed 2w agoCompare [ Source](https://github.com/quellabs/canvas-payments-paynl)[ Packagist](https://packagist.org/packages/quellabs/canvas-payments-paynl)[ RSS](/packages/quellabs-canvas-payments-paynl/feed)WikiDiscussions main Synced 3w ago READMEChangelogDependencies (12)Versions (6)Used By (0) Pay.nl Payment Provider ======================= [](#paynl-payment-provider) A Pay.nl payment provider for the Canvas framework. Part of the Canvas payments ecosystem. Installation ------------ [](#installation) ``` composer require quellabs/canvas-payments-paynl ``` Architecture ------------ [](#architecture) This package sits between the Pay.nl 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) │ ▼ Pay.nl (this package — implements the interface) │ ▼ PayNLGateway (raw Pay.nl TGU API calls) ``` Exchange processing is decoupled from your application via signals. When Pay.nl calls the exchange URL, the package emits a `payment_exchange` signal carrying a `PaymentState`. Your application listens for that signal and handles it. Configuration ------------- [](#configuration) Create `config/paynl.php` in your Canvas application: ``` return [ 'token_code' => '', // AT-xxxx-xxxx 'api_token' => '', // 40-character hash 'service_id' => '', // SL-xxxx-xxxx 'test_mode' => false, 'return_url' => 'https://example.com/order/thankyou', 'cancel_return_url' => 'https://example.com/order/cancelled', 'exchange_url' => 'https://example.com/webhooks/paynl', 'default_currency' => 'EUR', ]; ``` KeyRequiredDescription`token_code`YesYour Pay.nl token code (`AT-xxxx-xxxx`), found under Merchant → Company information`api_token`YesYour 40-character API token, found under Merchant → Company information`service_id`YesYour sales location ID (`SL-xxxx-xxxx`), found under Settings → Sales locations`test_mode`NoEnables Pay.nl test mode per-order (`integration.test: true`). Defaults to `false``return_url`YesURL the customer is redirected to after the package handles a completed/pending payment`cancel_return_url`YesURL the customer is redirected to after the package handles a cancelled payment`exchange_url`YesFull URL Pay.nl POSTs exchange notifications to. Must be publicly reachable`default_currency`NoISO 4217 currency code. Defaults to `EUR`Supported payment methods ------------------------- [](#supported-payment-methods) Module namePay.nl IDMethod`paynl_ideal`10iDEAL (NL)`paynl_bancontact`436Bancontact (BE)`paynl_creditcard`706Visa + Mastercard (combined)`paynl_visa`3141Visa`paynl_mastercard`3138Mastercard`paynl_amex`1705American Express`paynl_applepay`2277Apple Pay`paynl_googlepay`2558Google Pay`paynl_klarna`1717Klarna`paynl_in3`1813In3 (NL, EUR only)`paynl_riverty`2561Riverty / AfterPay (NL, BE, DE)`paynl_eps`2062EPS (AT)`paynl_trustly`2718Trustly (EU)`paynl_paybybank`2970Pay By Bank (PSD2)Payment methods must be activated for your sales location in the Pay.nl admin panel before use. Usage ----- [](#usage) ### Initiating a payment [](#initiating-a-payment) ``` 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(): Response { $request = new PaymentRequest( paymentModule: 'paynl_ideal', amount: 999, // in minor units — €9.99 currency: 'EUR', description: 'Order #12345', reference: 'order-12345', ); try { $result = $this->router->initiate($request); return $this->redirect($result->redirectUrl); } catch (PaymentInitiationException $e) { // handle error } } } ``` ### Handling refunds [](#handling-refunds) ``` use Quellabs\Payments\Contracts\RefundRequest; use Quellabs\Payments\Contracts\PaymentRefundException; // Full refund — omit amount $request = new RefundRequest( paymentReference: $state->transactionId, // UUID from payment_exchange signal paymentModule: 'paynl_ideal', amount: null, // null = full refund currency: 'EUR', description: 'Full refund for order #12345', ); // Partial refund — provide amount in minor units $request = new RefundRequest( paymentReference: $state->transactionId, paymentModule: 'paynl_ideal', amount: 500, // €5.00 currency: 'EUR', description: 'Partial refund for order #12345', ); try { $result = $this->router->refund($request); echo $result->refundId; } catch (PaymentRefundException $e) { // handle error } ``` ### 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::Refunded => $this->handleRefund($state), PaymentStatus::Failed => $this->markFailed($state->transactionId), default => null, }; } } ``` License ------- [](#license) MIT ### Health Score 39 — LowBetter than 85% of packages Maintenance95 Actively maintained with recent releases Popularity0 Limited adoption so far Community2 Small or concentrated contributor base Maturity50 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 ~16 days Total 5 Last Release 34d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/57e4ab872b3e37536367f2d26b192df3d3bb6a6a1cebec9a104d14a6d2ffe157?d=identicon)[noescom](/maintainers/noescom) --- Tags paymentsidealcanvaspay.nlpayment gatewaynetherlandscanvas-payments ### Embed Badge ![Health badge](/badges/quellabs-canvas-payments-paynl/health.svg) ``` [![Health](https://phpackages.com/badges/quellabs-canvas-payments-paynl/health.svg)](https://phpackages.com/packages/quellabs-canvas-payments-paynl) ``` PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)