PHPackages                             setono/payum-quickpay - 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. setono/payum-quickpay

ActiveLibrary[Payment Processing](/categories/payments)

setono/payum-quickpay
=====================

QuickPay gateway for Payum

v1.5.0(10mo ago)153.9k↓37.8%2[1 issues](https://github.com/Setono/payum-quickpay/issues)[6 PRs](https://github.com/Setono/payum-quickpay/pulls)1MITPHPPHP >=7.4CI failing

Since Feb 13Pushed 1w ago1 watchersCompare

[ Source](https://github.com/Setono/payum-quickpay)[ Packagist](https://packagist.org/packages/setono/payum-quickpay)[ Docs](https://setono.com)[ RSS](/packages/setono-payum-quickpay/feed)WikiDiscussions 2.x Synced 2w ago

READMEChangelog (10)Dependencies (8)Versions (13)Used By (1)

Payum Quickpay Gateway
======================

[](#payum-quickpay-gateway)

[![Latest Version on Packagist](https://camo.githubusercontent.com/fb71cdcaf10ba36bf1bb4f6a810ae3653f18e2ddbe53d2a5a5eb031396609e4c/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f7365746f6e6f2f706179756d2d717569636b7061792e7376673f696e636c7564655f70726572656c6561736573267374796c653d666c61742d737175617265)](https://packagist.org/packages/setono/payum-quickpay)[![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE)[![Build Status](https://github.com/Setono/payum-quickpay/actions/workflows/build.yaml/badge.svg?branch=2.x)](https://github.com/Setono/payum-quickpay/actions/workflows/build.yaml?query=branch%3A2.x)[![Code Coverage](https://camo.githubusercontent.com/569b3920f9eb4dc632c700df2825af6fb0ad0c877e04b75eca1083c3ec9918cb/68747470733a2f2f636f6465636f762e696f2f67682f5365746f6e6f2f706179756d2d717569636b7061792f6272616e63682f322e782f67726170682f62616467652e737667)](https://codecov.io/gh/Setono/payum-quickpay/branch/2.x)[![Mutation testing badge](https://camo.githubusercontent.com/dcf39e8dc75af964671a3644b87f173d40ccaecc123eea542af4a5414ec4a9ab/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e743f7374796c653d666c61742d7371756172652675726c3d687474707325334125324625324662616467652d6170692e737472796b65722d6d757461746f722e696f2532466769746875622e636f6d2532465365746f6e6f253246706179756d2d717569636b706179253246322e78)](https://dashboard.stryker-mutator.io/reports/github.com/Setono/payum-quickpay/2.x)

This component enables the use of Quickpay with Payum. Under the hood it uses the [`setono/quickpay-php-sdk`](https://github.com/Setono/quickpay-php-sdk) client.

> **Upgrading from 1.x?** See [`docs/UPGRADE-2.0.md`](docs/UPGRADE-2.0.md).

Installation
------------

[](#installation)

```
composer require setono/payum-quickpay
```

The SDK relies on [HTTPlug discovery](https://docs.php-http.org/en/latest/discovery.html), so your project must provide a [PSR-18 HTTP client](https://packagist.org/providers/psr/http-client-implementation)and [PSR-17 message factories](https://packagist.org/providers/psr/http-factory-implementation). If you do not already have them, install e.g.:

```
composer require kriswallsmith/buzz nyholm/psr7
```

Configuration
-------------

[](#configuration)

The gateway requires your Quickpay **API key** (Settings → API user) and **private key** (Settings → Integration — used to verify callback signatures). Other options are optional:

OptionDefaultDescription`api_key`—**Required.** Quickpay API key.`private_key`—**Required.** Private key; used to verify the callback HMAC.`auto_capture``0`Capture automatically once an approved authorize is confirmed.`payment_methods``''`Restrict the payment-window methods (e.g. `creditcard`). See below.`order_prefix``''`Prepended to the Payum payment number to form the Quickpay order id.`language``en`Payment-window language.`synchronized``false`Run capture/refund/cancel synchronously instead of via callbacks.`agreement_id``''`Optional payment-window agreement id.`branding_id``''`Optional payment-window branding id.The 1.x names `apikey`, `privatekey` and `agreement` are still accepted as deprecated aliases, so an existing gateway configuration keeps working. They will be removed in 3.0.

The factory name is exposed as a constant, so consumers looking gateways up by `factoryName`, tagging services, or guarding "is this a Quickpay payment?" need not repeat the literal:

```
use Setono\Payum\Quickpay\QuickpayGatewayFactory;

QuickpayGatewayFactory::NAME;   // 'quickpay'
```

```