Download the PHP package localgovdrupal/govuk_pay without Composer
On this page you can find all versions of the php package localgovdrupal/govuk_pay. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download localgovdrupal/govuk_pay
More information about localgovdrupal/govuk_pay
Files in localgovdrupal/govuk_pay
Package govuk_pay
Short Description Provides integration with GOV.UK Pay for Drupal.
License GPL-2.0-or-later
Homepage https://drupal.org/project/govuk_pay
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package govuk_pay
GOV.UK Pay for Drupal
Overview
This module provides integration with the GOV.UK Pay service for Drupal websites. GOV.UK Pay is the UK government's online payment service that allows users to make payments for government services.
Features
- Secure API integration with GOV.UK Pay service
- Bearer token authentication with the GOV.UK Pay API
- Base configuration and service methods for other modules to utilize
- Extensible architecture allowing for additional payment functionality
- Webhook integration for automatic payment status updates
Requirements
- Drupal 9.x or 10.x
- Access to a GOV.UK Pay account and API key
Installation
-
Install the module using Composer:
- Enable the module through the Drupal admin interface or using Drush:
Configuration
- Navigate to the configuration page at Administration → Configuration → Web services → GOV.UK Pay
- Enter your GOV.UK Pay API key
- Configure the payment reference format that will appear on all completed payments
- Save the configuration
API Authentication
The module handles authentication with the GOV.UK Pay API using the HTTP Bearer token format in the Authorization header. The API key is stored in Drupal's configuration system. You may want to override this key in your environment's settings.local.php file. To do so you would add the following lines:
Webhooks
The module provides a webhook endpoint that automatically updates payment entity statuses when they change in the GOV.UK Pay system. This ensures your Drupal site always has the most up-to-date payment information, even if users don't return to your site after completing a payment.
Webhook Endpoint
The webhook endpoint is available at:
Setting Up Webhooks in GOV.UK Pay
- Log in to your GOV.UK Pay account
- Navigate to the webhook settings section
- Add a new webhook with your site's URL:
https://your-domain.com/api/govuk-pay/webhook - Select which payment status events you want to receive notifications for (recommended: all status changes)
How It Works
When a payment status changes in GOV.UK Pay:
- GOV.UK Pay sends a notification to your webhook endpoint
- The webhook controller validates the incoming data
- The controller finds the corresponding payment entity in your Drupal site
- The payment status is updated to match the current status in GOV.UK Pay
- All actions are logged for auditing and debugging purposes
Security Considerations
- The webhook endpoint is publicly accessible (as required for webhooks)
- Basic validation is performed on all incoming webhook data
- For additional security, consider implementing IP restrictions at the server level to only allow requests from GOV.UK Pay IP addresses
Extension
This module provides the base integration with GOV.UK Pay. Additional functionality is available through submodules:
- GOV.UK Pay Webform: Adds GOV.UK Pay integration to Drupal Webforms
Troubleshooting
- Ensure your API key is valid and has the correct permissions
- Check the Drupal logs for any API communication errors
- Verify your server can make outbound HTTPS requests to the GOV.UK Pay API endpoints
Credits
Originally developed by Webcurl. Refactored and updated by Royal Borough of Greenwich.
License
This project is licensed under the GNU General Public License v2.0 or later.
