Skip to main content

Connect your live account to ePDQ

This is part of going live.

To connect your live account to ePDQ, you must:

  • have already connected at least one live GOV.UK account to ePDQ before 1 August 2020
  • be an admin on both your GOV.UK Pay and ePDQ accounts

If you do not meet these requirements, you must connect your live GOV.UK Pay account to either GOV.UK’s contracted payment service provider (PSP) or Government Banking’s contracted PSP.

Add payment methods to your account

If you only want to accept Visa and Mastercard, you do not need to follow these steps, because ePDQ will have already added them by default.

  1. Sign in to your ePDQ account.

  2. Select the Configuration tab, then Payment methods.

  3. Select Choose new payment methods.

  4. Select Add next to the card types you want to accept.

  5. Complete the fields on the Contract data tab, then select Submit.

  6. Select the PM activation tab, then select Yes for Activation.

  7. Select Submit.

Set up security parameters

Set the hashing method

  1. Select the Configuration tab.

  2. On the Technical Information tab, select the Global security parameters tab.

  3. Set Hash algorithm to SHA-512.

  4. Set Character encoding to UTF-8.

  5. Select Save.

Set the payment capture method

  1. On the Technical Information tab, select the Global transaction parameters tab.

  2. Set Default operation code to Authorisation.

  3. Set Default data capture (payment) procedure to Data capture by the merchant (manual or automatic).

  4. Select Save.

Set a SHA-IN passphrase

  1. Select the Data and origin verification tab.

  2. Go to the Checks for e-Commerce & Alias Gateway section.

  3. Leave the following field blank: URL of the merchant page containing the payment form that will call the page: orderstandard.asp.

  4. Enter a SHA-IN passphrase in plain text - do not use a hash.

    You should follow the NCSC guidance on choosing and storing passwords. You cannot use ^, {, }, [, ], “, ‘, |, <, or >.

    You’ll need to copy this passphrase into your GOV.UK Pay account later.

  5. Go to the Checks for Barclaycard Direct Link section.

  6. Leave the IP address blank.

  7. Enter the same SHA-IN passphrase you entered in step 4, then select Save.

Set up notification settings

Set up server-to-server request parameters

  1. Select the Transaction feedback tab.

  2. Go to the e-Commerce section, then the Direct HTTP server-to-server request section.

  3. Leave Timing of the request as the default No request setting.

  4. Leave the following field blank: If the payment’s status is “accepted”, “on hold” or “uncertain”

  5. Leave the following field blank: If the payment’s status is “cancelled by the client” or “too many rejections by the acquirer”

  6. Set the Request method to POST.

  7. Go to the Dynamic e-Commerce parameters section.

  8. Check if PAYIDSUB is in the Selected box. If it’s not, find PAYIDSUB in the Available box, select it, then select > to add it to the Selected box.

Set up security for request parameters

  1. Go to All transaction submission modes, then the Security for request parameters section.

  2. Enter a SHA-OUT passphrase in plain text - do not use a hash.

    You should follow the NCSC guidance on choosing and storing passwords. from the National Cyber Security Centre (NCSC). You cannot use ^, {, }, [, ], “, ‘, |, <, or >.

    You’ll need to copy this passphrase into your GOV.UK Pay account later.

  3. Go to the HTTP request for status change section, then set Timing of the request to For each offline status change (payment, cancellation, etc.)

  4. In the URL on which the merchant wishes to receive a deferred HTTP request, should the status of a transaction change offline field, enter https://notifications.payments.service.gov.uk/v1/api/notifications/epdq

  5. Select Save.

Set up an ‘API user’

You must set up the username and password that ePDQ will use to connect to the GOV.UK Pay API.

Add user management to your account

To create an ‘API user’, you need to add user management to your account first.

  1. Select the Account tab.

  2. Select the Your options tab.

  3. Under the Available options tab, select Activate next to one of the User Manager options.

  4. On the General Conditions screen, select Accept.

  5. Sign out, then sign back in again.

Create an API user

  1. Select the Users tab, then New User.

    If you cannot see the New User button, check that you added user management to your account in the step above

  2. Complete the UserID and User’s name fields.

    You’ll need to copy the UserID into your GOV.UK Pay account later.

  3. Complete the E-mail address field.

    ePDQ will send notifications about your account to this email address.

  4. In the Profile field, select Admin.

  5. Select the Special user for API (no access to admin.) option.

  6. Enter your own ePDQ password and select Create.

  7. Set a password for the API user, then select Submit.

    You should follow the guidance about choosing and storing passwords from the National Cyber Security Centre (NCSC).

    You’ll need to copy this password into your GOV.UK Pay account later.

Copy your details into your GOV.UK Pay account

You must copy your details from your ePDQ account to your GOV.UK Pay live account.

  1. Select your live account from the Overview page in the GOV.UK Pay admin tool.

  2. Select Your PSP - ePDQ.

  3. In the PSP ID field, enter your PSP ID for ePDQ.

  4. In the Username field, enter the UserID of the API user you created.

  5. In the Password field, enter the password of the API user you created.

  6. In the SHA-IN passphrase field, enter the SHA-IN passphrase you created.

  7. In the SHA-OUT passphrase field, enter the SHA-OUT passphrase you created.

  8. Select Save credentials.