Skip to article
DocumentationGuides & reference

Search across guides and reference articles. Try “email”, “API” or “conditions”.

Service Settings

Payment settings: providers, accounts and fees

Configure payments in Service settings → Payment. Use your own merchant account, choose the fee rules and test the complete applicant journey before publishing.

Choose a supported provider connection

Provider availability and your service’s setup status are separate. Early access connections require merchant-account validation during setup. On request providers support design and simulation while Govform Support arranges the connection.

ProviderSupported connectionAvailability
GOV.UK PayPayments API, hosted payment pagesAvailable
Access PaySuite / Pay360Payment Page RESTEarly access
WorldpayAccess Hosted Payment PagesEarly access
AdyenHosted Checkout, manual captureEarly access
Global PaymentsGP API Hosted Payment PageEarly access
StripeHosted Checkout SessionsEarly access
PayPal CheckoutOrders v2Early access
Civica Income Management / CybersourceConnection arranged with SupportOn request

The supported product matters: Global Payments legacy Realex HPP credentials, for example, do not work with the GP API connection. Use the requirements shown for your selected provider.

Connect your account

  1. Enable payment and select the provider in the Connection tab. For an On request provider, follow Request this payment provider and add it to the service.
  2. Enter the required Account details for each environment: test details for QA and Staging, live details for Production. Shared details are stored in library Properties and encrypted Secrets; the service keeps their references. Existing entries can be reused across services.
  3. Set the minimum and maximum amounts agreed for the account. Configure any notifications using the environment addresses shown in Builder and reachable HTTPS. Adyen requires manual capture and signed AUTHORISATION, CAPTURE and CAPTURE_FAILED notifications.
  4. Save payment settings. Check QA connection checks read access without taking a payment or saving changes. It does not establish that checkout, return or notifications will work.

When replacing an account, keep its original saved details until outstanding payments are resolved. Switch to a different saved entry rather than overwriting details that those attempts still need.

Set the charge and exemptions

In Payment details, enter the public payee, description, reference and currency. Choose a currency enabled on the merchant account and supported by the selected connection; GOV.UK Pay uses GBP.

Use a positive Fixed amount, or Calculated from answers with server-side Liquid. Enter amounts in major units, such as 75.50 for £75.50. A calculated zero means no payment is required and the response completes normally. Blank, negative or invalid amounts are errors.

Under Who pays?, apply the fee to all applicants or use conditions for exemptions. Conditions are checked before the calculated amount. Include every answer, declaration and Check your answers page before the final submit.

Test and publish

User view simulates payments. QA and Staging also simulate while an On request connection is under review or mandatory setup is missing. Simulation takes no money; actions, emails and workflows still follow their normal environment behaviour. Production never simulates: an unavailable connection prevents submission.

Test success, pending, decline, cancellation, expiry and unresolved outcomes. Then use your provider’s permitted test account to check the exact amount and reference, hosted checkout, return, notifications, receipt and recovery. Publish the service and its environment settings through the normal deployment process.

Which services can take payment?

Payment supports signed-in services with one payment after the final submit. Task lists need an End task. Anonymous services, embedded child forms and managed Collection forms cannot take payments. Subscriptions, instalments, saved cards and payment partway through a journey are outside this payment flow.

Next: Understand payment completion, recovery and casework, or explore payment capabilities.

More in builder reference