Skip to main content

GOV.UK Pay Payments Adapter

GOV.UK Pay is a free service, available to public sector organisations to take online card payments.

This adapter allows you to take payments using GOV.UK Pay.

  1. Click the PayBridge icon in the left navigation bar. The PayBridge menu will open.
  2. Click the Settings link and a settings form will be shown. The view on page load is "Adapters".
  3. Click the GovUK Pay option in the list of adapters. The GovUK Pay settings form will open.

Configure the adapter​

From the adapter settings interface you can configure the installed payment adapters on your server.

You should enter the account details given to you by your payment provider, to ensure PayBridge can communicate with your payment portal.

To do this:

  1. Navigate to the GOV.UK Pay payment adapter area.
  2. Enter any provided details into the fields on the right.
  3. Click the Save button to save your changes.

GOV.UK Pay fields​

FieldNotesRequired?
Test modeTarget your test portal. This is useful for UAT sites, or during development, as test cards can be used.
Random reference modeAdd a random string into the order reference generated by payBridge. This is useful to avoid duplicate references. For instance, if you have order number 1 on a test box, then order number 1 on UAT, the payment portal may reject the UAT request because the order number is a duplicate. Jadu recommends using Random Reference Mode everywhere apart from in production.
Status checkingSome payment providers support Status Checking, where PayBridge can check the payment portal is available, and show the customer a maintenance page when it is not
GovUK Pay Service API KeyThe API key you use determines which GOV.UK Pay service you use, and whether actions are treated as test payments, or processed as real payments. You can create test and live API keys through the GOV.UK Pay admin tool.✅
Metadata fieldsAdd metadata to your transactions to make it easier to reconcile payments. Add metadata to cost centre or ledger codes, customer IDs or any data you need to track.