Releases

eDesigner - v2.8 (Payment Enhancements/Amendments)

1) GOV.UK Pay

 

In this version of eDesigner, we have enhanced the GOV.UK Pay integration to leverage use of the 'Custom Metadata' functionality in GOV.UK Pay.

 

This is described as follows:

 

"You can add custom metadata to a new payment. For example, you can add a reference number from your finance or accounting system, so you can reconcile the payment later.

You add metadata when you make an API call to create a new payment.

Your users cannot see metadata while they're making a payment."

 

And you can read more about it here:

https://docs.payments.service.gov.uk/custom_metadata/#add-custom-metadata

 

Essentially, as a council, you can pass additional, council-specific content to GOV.UK Pay whenever a payment is made on a form by form basis.

To access this open Click on the Design Tools button when in the Development environment of a form and click on 'Payment Settings' from the menu system:

 

Screenshot_2021-11-02_at_15.51.04.png

 

As well as the description that is passed to GOV.UK Pay, you will see there's now the ability to 'Add a new field' for Custom Metadata fields. The rules around these are provided at the top i.e.

  • Field names must be between 1 and 30 characters
  • You can have a maximum 10 custom metadata fields
  • String fields can be no more than 100 characters long

Screenshot_2021-11-02_at_16.28.28.png

When you click 'Add a new field' you're able to provide:

  • the name,
  • the value that should be populated,
  • the type (from a list of options that the GOV.UK Pay API supports)

 

Screenshot_2021-11-02_at_15.59.38.png

 

The following illustrates an example set of 5 custom metadata fields:

 

Screenshot_2021-11-02_at_15.49.31.png

 

What the above would mean is that the following is passed to GOV.UK Pay:

"metadata": {
"vatCode": "N",
"vatRate": "0.00",
"ledgerCode": "GL",
"accountString": "30-0-9999-9999-99999",
"service": "Waste",
}

 

2) Capita Pay360

We noticed that the Custom VAT code was not being passed across to Capita Pay360 and as a result we've added a new setting:

 

CapitaPaymentCustomVatCodeEnabled

 

Which when true will ensure that the VAT code will be passed to the Capita Pay360 application. 

 

Also if the VAT rate was 0 we were not sending anything but Capita Pay360 needs zero to be sent. So there is now another new setting:

 

CapitaPaymentZeroVatAmountEnabled

 

Which when true will ensure 0.00 is sent when the VAT rate is 0. 

 

Release Version Details

The following is the release version info for the version of eDesigner, which has this functionality.

 

Release Date Version Number
02/11/2021 2.8