netbums / laravel-quickpay
A fluent api around the quickpay api for Laravel applications
Fund package maintenance!
Netbums
Requires
- php: ^8.2
- illuminate/contracts: ^v12.0.1
- quickpay/quickpay-php-client: ^2.0
- spatie/laravel-package-tools: ^1.14.0
Requires (Dev)
- laravel/pint: ^v1.21.0
- nunomaduro/collision: ^v8.6.1
- orchestra/testbench: ^v10.0.0
- pestphp/pest: ^v3.7.4
- pestphp/pest-plugin-arch: ^v3.0.0
- pestphp/pest-plugin-laravel: ^v3.1.0
- phpstan/extension-installer: ^1.4.3
- phpstan/phpstan-deprecation-rules: ^2.0.1
- phpstan/phpstan-phpunit: ^2.0.4
This package is auto-updated.
Last update: 2025-04-23 18:16:17 UTC
README
This laravel package will help you utilize the Quickpay API Client, without knowing too much about the endpoints. It provides a fluent api for using the API. See examples below.
Support me
Consider supporting me by sponsoring my work
Installation
- You can install the package via composer:
composer require netbums/laravel-quickpay
- Publish the config file with:
php artisan vendor:publish
Search for "quickpay", and publish both the config and Netbums\Quickpay\QuickpayServiceProvider
This is the contents of the published config file:
// config/quickpay.php return [ 'api_key' => env('QUICKPAY_API_KEY'), 'login' => env('QUICKPAY_LOGIN'), 'password' => env('QUICKPAY_PASSWORD'), 'merchant_id' => env('QUICKPAY_MERCHANT_ID'), ];
- Add the environment variables to your
.env
file:
QUICKPAY_API_KEY=
And alternatively, you can add the following environment variables to your .env
file instead of the QUICKPAY_API_KEY
:
QUICKPAY_LOGIN= QUICKPAY_PASSWORD= QUICKPAY_MERCHANT_ID=
Usage
Payments
Get all payments
use \Netbums\Quickpay\Facades\Quickpay; $payments = Quickpay::payments()->all();
Get a payment
Getting a single payment by id
use \Netbums\Quickpay\Facades\Quickpay; $payment = Quickpay::payments()->find($paymentId);
Create a payment
First create a basket with items, and then create a payment with the basket and a unique order id.
use \Netbums\Quickpay\DataObjects\Basket; use \Netbums\Quickpay\DataObjects\BasketItem; use \Netbums\Quickpay\DataObjects\Payment; use \Netbums\Quickpay\Facades\Quickpay; $basket = new Basket( items: [ new BasketItem( qty: 1, item_name: 'Test item', item_no: 'sku-1234', item_price: 100, // in smallest currency unit vat_rate: 0.25, // 25% ) ] ); $paymentData = new Payment( currency: 'DKK', order_id: '1234', basket: $basket, ); $createdPayment = Quickpay::payments()->create( payment: $paymentData );
After a payment is created you can create a payment link for it, and redirect the user to the payment link.
Create a payment link
use \Netbums\Quickpay\Facades\Quickpay; use \Netbums\Quickpay\DataObjects\PaymentLink; $paymentLinkData = new PaymentLink( id: $createdPayment['id'], amount: 100 ); $paymentLink = Quickpay::payments()->createLink($paymentLinkData);
This will return a URL, that you can redirect the user to.
Update a payment
Capture a payment
Capture a payment. This will capture the amount of the payment specified.
use \Netbums\Quickpay\Facades\Quickpay; $payment = Quickpay::payments()->capture( id: $paymentId, amount: 100, // in smallest currency unit );
Refund a payment
Refund a payment. This will refund the amount of the payment specified.
use \Netbums\Quickpay\Facades\Quickpay; $payment = Quickpay::payments()->refund( id: $paymentId, amount: 100, // in smallest currency unit );
Authorize a payment
Authorize a payment. This will reserve the amount on the card, but not capture it.
use \Netbums\Quickpay\Facades\Quickpay; $payment = Quickpay::payments()->authorize( id: $paymentId, amount: 100, // in smallest currency unit );
Renew authorization of a payment
Renew the authorization of a payment. This will reserve the amount on the card, but not capture it.
use \Netbums\Quickpay\Facades\Quickpay; $payment = Quickpay::payments()->renew( id: $paymentId, );
Cancel a payment
Cancel a payment. This will cancel the payment, and release the reserved amount on the card.
use \Netbums\Quickpay\Facades\Quickpay; $payment = Quickpay::payments()->cancel( id: $paymentId, );
Create a payment link
Create a payment link for a payment. Optional parameters are: language
, continue_url
, cancel_url
, callback_url
:
use \Netbums\Quickpay\Facades\Quickpay; use \Netbums\Quickpay\DataObjects\PaymentLink; $paymentLinkData = new PaymentLink( id: $paymentId, amount: 100, // in smallest currency unit language: 'da', continue_url: 'https://example.com/continue', cancel_url: 'https://example.com/cancel', callback_url: 'https://example.com/callback', ); $paymentLink = Quickpay::payments()->createPaymentLink( paymentLink: $paymentLinkData, );
Create a payment session
use \Netbums\Quickpay\Facades\Quickpay; $session = Quickpay::payments()->session( id: $paymentId, amount: 100, // in smallest currency unit );
Create Fraud Report
Create a fraud report for a payment. Optional parameters are: description
:
use \Netbums\Quickpay\Facades\Quickpay; $fraudReport = Quickpay::payments()->createFraudReport( id: $paymentId, description: 'Fraudulent payment', );
Subscriptions
The Quickpay::subscriptions()
facade provides a fluent API for interacting with Quickpay Subscription endpoints.
Get all subscriptions
use \Netbums\Quickpay\Facades\Quickpay; $subscriptions = Quickpay::subscriptions()->all();
Get a subscription
Get a single subscription by id.
use \Netbums\Quickpay\Facades\Quickpay; $subscriptionId = 'your_subscription_id'; $subscription = Quickpay::subscriptions()->find($subscriptionId);
Create a subscription link
Create a payment link for a subscription. Requires a SubscriptionLink
DataObject.
use \Netbums\Quickpay\Facades\Quickpay; use \Netbums\Quickpay\DataObjects\SubscriptionLink; $subscriptionLinkData = new SubscriptionLink( id: $createdSubscription['id'], amount: 100, // in smallest currency unit order_id: 'link_'.uniqid(), language: 'en', continue_url: 'https://example.com/continue', cancel_url: 'https://example.com/cancel', callback_url: 'https://example.com/callback' // API ); $subscriptionLink = Quickpay::subscriptions()->createSubscriptionLink($subscriptionLinkData);
Delete a subscription payment link
Delete the payment link for a subscription.
use \Netbums\Quickpay\Facades\Quickpay; $subscriptionId = 'your_subscription_id'; Quickpay::subscriptions()->deletePaymentLink($subscriptionId);
Create a subscription
Create a new subscription. Requires a Subscription
DataObject.
use \Netbums\Quickpay\Facades\Quickpay; use \Netbums\Quickpay\DataObjects\Subscription; $subscriptionData = new Subscription( currency: 'DKK', order_id: 'order_'.uniqid(), description: 'Subscription description', // Example description // Add other relevant Subscription properties based on Quickpay docs if known // e.g., frequency: 30 ); $createdSubscription = Quickpay::subscriptions()->create($subscriptionData);
Update a subscription
Update a subscription. Requires the subscription ID and an array of data.
use \Netbums\Quickpay\Facades\Quickpay; $subscriptionId = 'your_subscription_id'; $updateData = [ 'state' => 'active', // ... other update properties ]; $updatedSubscription = Quickpay::subscriptions()->update($subscriptionId, $updateData);
Authorize a subscription
Authorize a subscription.
use \Netbums\Quickpay\Facades\Quickpay; $subscriptionId = 'your_subscription_id'; $authorizedSubscription = Quickpay::subscriptions()->authorize($subscriptionId);
Cancel a subscription
Cancel a subscription.
use \Netbums\Quickpay\Facades\Quickpay; $subscriptionId = 'your_subscription_id'; $canceledSubscription = Quickpay::subscriptions()->cancel($subscriptionId);
Create a recurring payment
Create a recurring payment for a subscription.
use \Netbums\Quickpay\Facades\Quickpay; use \Netbums\Quickpay\DataObjects\SubscriptionRecurring; $subscriptionRecurringData = new SubscriptionRecurring( id: $subscriptionId, amount: 100 // in smallest currency unit // ... other SubscriptionRecurring properties ); $recurringPayment = Quickpay::subscriptions()->createRecurring($subscriptionRecurringData);
Create a fraud report
Create a fraud report for a subscription.
use \Netbums\Quickpay\Facades\Quickpay; $subscriptionId = 'your_subscription_id'; $fraudReport = Quickpay::subscriptions()->fraudReport($subscriptionId);
Get subscription payments
Get payments associated with a subscription.
use \Netbums\Quickpay\Facades\Quickpay; $subscriptionId = 'your_subscription_id'; $payments = Quickpay::subscriptions()->getPayments($subscriptionId);
Exception Handling
Dedicated exception classes are provided for handling errors during subscription operations. These include:
FetchSubscriptionFailed
FetchSubscriptionsFailed
CreateRecurringFailed
CreateSubscriptionFailed
CreateSubscriptionLinkFailed
DeletePaymentLinkFailed
UpdateSubscriptionFailed
AuthorizeSubscriptionFailed
CancelSubscriptionFailed
FraudReportSubscriptionFailed
GetSubscriptionPaymentsFailed
You should wrap your Quickpay subscription calls in try-catch blocks to handle these specific exceptions.
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.