PHPackages memeoirs/paymill-bundle - 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. memeoirs/paymill-bundle ActiveSymfony-bundle[Payment Processing](/categories/payments) memeoirs/paymill-bundle ======================= Paymill payments for Symfony apps v0.3.1(9y ago)121.1k8[2 issues](https://github.com/regularjack/paymill-bundle/issues)MITPHPPHP >=5.3.2 Since Jan 20Pushed 8y ago2 watchersCompare [ Source](https://github.com/regularjack/paymill-bundle)[ Packagist](https://packagist.org/packages/memeoirs/paymill-bundle)[ Docs](https://github.com/memeoirs/paymill-bundle)[ RSS](/packages/memeoirs-paymill-bundle/feed)WikiDiscussions master Synced yesterday READMEChangelog (10)Dependencies (4)Versions (14)Used By (0) paymill-bundle [![Build Status](https://camo.githubusercontent.com/09390f67adb436b959fb2b0f886084178edfd73508c6f48a1ee371ebe177e67f/68747470733a2f2f7472617669732d63692e6f72672f726567756c61726a61636b2f7061796d696c6c2d62756e646c652e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/memeoirs/paymill-bundle) ========================================================================================================================================================================================================================================================================================================================= [](#paymill-bundle-) Straight forward integration of [Paymill](http://paymill.com) payments into Symfony applications. [![Credit card form screenshot](Resources/doc/form.png)](Resources/doc/form.png) Features ======== [](#features) - Plug-and-play credit card form, inspired by Stripe's Checkout (optional) - High level API to create payments - [Webhooks](https://www.paymill.com/it-it/documentation-3/reference/api-reference/#webhooks) - CRUD access to Paymill's API from the command line using Symfony commands - Support for Paymill's [client resources](https://www.paymill.com/it-it/documentation-3/reference/api-reference/#clients) - Uses [Paymill's PHP library](https://github.com/Paymill/Paymill-PHP) under the hood Setup ===== [](#setup) *This bundle uses functionality provided by [JMSPaymentCoreBundle](https://github.com/schmittjoh/JMSPaymentCoreBundle) which allows you to add new payment backends (e.g. Paypal) with minimum changes to your code. These instructions will also guide you through the installation of that bundle.* Installation ------------ [](#installation) Install with composer: ``` composer require memeoirs/paymill-bundle ``` Then register the bundles in `AppKernel.php`: ``` // app/AppKernel.php $bundles = array( // ... new JMS\Payment\CoreBundle\JMSPaymentCoreBundle(), new Memeoirs\PaymillBundle\MemeoirsPaymillBundle(), // ... ); ``` Include `routing.yml` in your routing file (for webhooks): ``` // app/config/routing.yml memeoirs_paymill: resource: "@MemeoirsPaymillBundle/Resources/config/routing.yml" ``` Configuration ------------- [](#configuration) [JMSPaymentCoreBundle's](https://github.com/schmittjoh/JMSPaymentCoreBundle) configuration is as easy as choosing a random secret string which will be used for encrypting data. Note that if you change the secret all data encrypted with the old secret will become unreadable. ``` jms_payment_core: secret: somesecret ``` Finally, you need to specify Paymill's private and public keys. You'll need to create a Paymill account if you don't have one and retrieve it's private and public keys. Refer to [Paymill's documentation](https://www.paymill.com/en-gb/documentation-3/introduction/brief-instructions/) for information on how to accomplish this. ``` // app/config.yml memeoirs_paymill: api_private_key: paymill_api_private_key api_public_key: paymill_api_public_key ``` Create database tables ---------------------- [](#create-database-tables) JMSPaymentCoreBundle needs a few database tables so you'll have to create them. If you want to know more about the data model see [JMSPaymentCoreBundle's documentation](http://jmsyst.com/bundles/JMSPaymentCoreBundle/master/model). If you're using [database migrations](http://symfony.com/doc/current/bundles/DoctrineMigrationsBundle/index.html), you can create the new tables with following commands: ``` php app/console doctrine:migrations:diff php app/console doctrine:migrations:migrate ``` Or, without migrations: ``` php app/console doctrine:schema:update ``` Usage ===== [](#usage) Rendering the form ------------------ [](#rendering-the-form) You'll need a new route: ``` // app/config/routing.yml checkout: pattern: / defaults: { _controller: AcmeDemoBundle:Orders:checkout } ``` And a controller action to render the form: ``` namespace Acme\DemoBundle\Controller; use Acme\DemoBundle\Entity\Order; use Memeoirs\PaymillBundle\Controller\PaymillController; class OrdersController extends PaymillController { public function checkoutAction () { $em = $this->getDoctrine()->getManager(); // In a real world app, instead of instantiating an Order, you will // probably retrieve it from the database $order = new Order; $order->setAmount(50); $order->setCurrency('EUR'); $form = $this->getPaymillForm($order->getAmount(), $order->getCurrency()); return $this->render('AcmeDemoBundle::checkout.html.twig', array( 'form' => $form->createView(), 'order' => $order, )); } } ``` The twig template: ``` // src/Acme/DemoBundle/Resources/views/checkout.html.twig {{ paymill_initialize(order.amount, order.currency) }} {# looks better with bootstrap #} {% form_theme form 'MemeoirsPaymillBundle::form.html.twig' %} {{ form_widget(form) }} {{ form_errors(form) }} ``` `paymill_initialize()` renders the [Resources/views/init.html.twig](Resources/views/init.html.twig) template. If you need to change the output of `paymill_initialize` you can use your own template: ``` // app/config/config.yml memeoirs_paymill: initialize_template: AcmeDemoBundle::init_paymill.html.twig ``` Accepting the payment --------------------- [](#accepting-the-payment) When the user clicks the *buy* button, an Ajax request is made to paymill's servers containing the credit card information. The response to this request is a unique *token*. The form is then submitted through Ajax, excluding the credit card information but including the *token*. You'll handle the form submission in the same controller action that renders the form: ``` // Acme\DemoBundle\Controller\OrdersController public function checkoutAction () { // (...) if ('POST' === $this->getRequest()->getMethod()) { $form->bind($this->getRequest()); if ($form->isValid()) { $instruction = $this->createPaymentInstruction($form); $order->setPaymentInstruction($instruction); $em->persist($order); $em->flush($order); // completePayment triggers a call to Paymill's API that creates the // the payment. It returns a JSON response that indicates success or // error. In the case of a successful operation the user will be // redirected (in javascript) to 'orders_thankyou'. return $this->completePayment($instruction, 'orders_thankyou', array( 'id' => $order->getId() )); } } return $this->render('AcmeDemoBundle:::checkout.html.twig', array( 'form' => $form->createView(), 'order' => $order, )); } ``` Specifying a Client ------------------- [](#specifying-a-client) Paymill allows you to *attach* each payment to a certain [client](https://www.paymill.com/it-it/documentation-3/reference/api-reference/#clients). To have this bundle automatically manage clients, you can pass the client information as additional data when creating the form: ``` // Acme\DemoBundle\Controller\OrdersController public function checkoutAction () { // ... $form = $this->getPaymillForm($order->getAmount(), $order->getCurrency(), array( 'client' => array( 'email' => 'user2@example.com', 'description' => 'John Doe', ), 'description' => 'Two baskets of apples' )); // ... } ``` Changing how the form looks --------------------------- [](#changing-how-the-form-looks) TODO Webhooks ======== [](#webhooks) A webhook is a controller action to which Paymill POSTs events. As of now, this bundle is able to automatically handle notifications for the following event types: `transaction.succeeded` and `refund.succeeded`. The only thing you need to do is create a webhook using the provided console command (see the *Console* section below): ``` app/console paymill:webhook:create --url=https://myapp.com/paymill/hook \ --event=transaction.succeeded --event=refund.succeeded ``` Everytime a successful transaction or refund happens, Paymill will post a request to the URL you provided, which maps to the [MemeoirsPaymillBundle:Webhooks:hook](Controller/WebhooksController.php) controller action (make sure you included [routing.yml](Resources/config/routing.yml) in your routing file). Console ======= [](#console) *Currently only webhooks are supported* The console commands give you CRUD access to Paymill's API from the command line. Webhooks -------- [](#webhooks-1) ### List webhooks [](#list-webhooks) The `paymill:webhook:list` command retrieves the list of the most recent webhooks: ``` app/console paymill:webhook:list ``` You can filter and paginate the results using a set of filters formatted as a HTTP query string. See [here](https://www.paymill.com/it-it/documentation-3/reference/api-reference/#list-webhooks) for the list of all available filters. To retrieve the second page of results ordered chronologically: ``` app/console paymill:webhook:list "count=10&offset=10&order=created_at_asc" ``` ### Create a webhook [](#create-a-webhook) The `paymill:webhook:create` command creates a new URL or Email webhook. For more information about webhooks see [Paymill's API documentation](https://www.paymill.com/it-it/documentation-3/reference/api-reference/#document-webhooks). To create a URL webhook specify the `--url` option: ``` app/console paymill:webhook:create --url=https://myapp.com/some-paymil-webhook ``` If instead you wish to create an Email webhook specify the `--email` option: ``` app/console paymill:webhook:create --email=payment@example.com ``` You can specifiy the events that trigger this webhook using multiple `--event` options. If no `--event` option is used, all events will be subescribed to. See [here](https://www.paymill.com/it-it/documentation-3/reference/api-reference/#events) for the list of available event types. ``` app/console paymill:webhook:create --url=... --event=transaction.succeeded --event=refund.succeeded ``` To create an inactive webhook use the `--disable` option: ``` app/console paymill:webhook:create --url=... --disable ``` ### Delete a webhook [](#delete-a-webhook) The `paymill:webhook:delete` command deletes webhooks. It takes a series of space-separated webhook ids as arguments: ``` app/console paymill:webhook:delete hook_c945c39154ab3b3e1ef6 hook_b4ae6600de00b9f69afa ``` License ======= [](#license) [MIT](Resources/meta/LICENSE) ### Health Score 31 — LowBetter than 68% of packages Maintenance17 Infrequent updates — may be unmaintained Popularity24 Limited adoption so far Community17 Small or concentrated contributor base Maturity55 Maturing project, gaining track record Bus Factor1 Top contributor holds 75.9% 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 Every ~78 days Recently: every ~173 days Total 12 Last Release 3631d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/eee2a7153146ac78d85783b92a9abdf64384078262183d741fce9635c8d83f64?d=identicon)[regularjack](/maintainers/regularjack) --- Top Contributors [![psrpinto](https://avatars.githubusercontent.com/u/550401?v=4)](https://github.com/psrpinto "psrpinto (60 commits)")[![Nyholm](https://avatars.githubusercontent.com/u/1275206?v=4)](https://github.com/Nyholm "Nyholm (15 commits)")[![EmmanuelVella](https://avatars.githubusercontent.com/u/663607?v=4)](https://github.com/EmmanuelVella "EmmanuelVella (2 commits)")[![jdeniau](https://avatars.githubusercontent.com/u/1398469?v=4)](https://github.com/jdeniau "jdeniau (1 commits)")[![Seldaek](https://avatars.githubusercontent.com/u/183678?v=4)](https://github.com/Seldaek "Seldaek (1 commits)") --- Tags paymentpaymill ### Embed Badge ![Health badge](/badges/memeoirs-paymill-bundle/health.svg) ``` [![Health](https://phpackages.com/badges/memeoirs-paymill-bundle/health.svg)](https://phpackages.com/packages/memeoirs-paymill-bundle) ``` ### Alternatives [payum/payum-bundle One million downloads of Payum already! Payum offers everything you need to work with payments. Check more visiting site. 59510.3M40](/packages/payum-payum-bundle)[jms/payment-paypal-bundle Payment Bundle providing access to the PayPal API 124405.8k1](/packages/jms-payment-paypal-bundle)[sylius/payment-bundle Flexible payments system for Symfony e-commerce applications. 22268.0k5](/packages/sylius-payment-bundle)[ets/payment-ogone-bundle Payment Bundle providing access to Ogone gateway 1246.0k](/packages/ets-payment-ogone-bundle)[karser/robokassa-bundle Bundle allows you to accept Robokassa payments 162.6k](/packages/karser-robokassa-bundle)[miracode/stripe-bundle Symfony bundle to integrate Stripe PHP SDK. Ability to save Stripe objects in database using Doctrine. 1016.1k](/packages/miracode-stripe-bundle) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)