You may wish to use query string parameters to prefill certain fields in the eDD page before your customer completes the sign up to Direct Debit. See here for the full list of current query string parameters.
šNote: Query strings are case sensitive and must be added exactly as they show on the query string parameters list.
šNote: All query strings must begin with a ? followed by the query string parameters. If your URL already includes a parameter such as ?locale=en-GB or ?locale=cy-GB, this counts as the first query string.
šNote: When using multiple query strings, they must be separated by an ampersand (&). If locale is already present, any additional parameters must be appended using & rather than another ?.
In order to use the query string(s) on your eDD URL either before sending to a customer or before adding to a button on your website, you must append it to the URL of the page, followed by the information you are using to prefill.
As an example, when using the amount query string:
?amount=125
If no other parameters are present, the URL shows as:
If a locale parameter is already included, the format becomes:
Welsh language URL parameter
Customers can access the bilingual form by appending locale=cy-GB to the registration URL.
Any additional parameters can be included by adding them using & in the same format as above.
This allows you to share or embed Welsh-language links for your customers. If Welsh support is not enabled for your organisation, the form will load in English.
Custom and additional references
If you're using eDD alongside Access PaySuite, you can include values in the URL when creating a contract.
Use ?altRef= to set the customerās Bank/Direct Debit reference
Use ?additionalReference= to add a secondary reference for searching
Add the value after each parameter before sharing the URL. When using both, combine them, for example: ?altRef=AP1234&additionalReference=REF001
Key requirements:
Values are case-sensitive
Each reference must be unique
Multiple parameters must use ? and &
These parameters allow you to control how contracts are created and make them easier to identify and search later in Access PaySuite.
šNote: The altRef parameter may need to be enabled on your Access PaySuite account. If you're unsure, please reach out to our support team and request to speak to an agent.