Developers

Roll Number Validation

Important note.

All BankVal web services are available on both the main and backup servers at our primary data centre. This configuration is mirrored at our secondary data centre. The two data centres are geographically independent. Using this configuration, the BankVal web service has been available continuously since launch in 2003.

In general:

  • Call the service at the primary data centre at www.unifiedservices.co.uk
  • In the unlikely event of a failure, call the service at the secondary data centre at www.unifiedsoftware.co.uk

1 Roll Number Validation - REST


Roll Number Validation functionality:

  • Validates a building society roll number (payment reference number) using validation rules specified by the building society.

Follow these three steps:-

  • 1. Attempt to access the service on unifiedservices.co.uk
  • 2. Check the http response code
  • 3. If this is < 200 or > 399, access the backup service on unifiedsoftware.co.uk

URI for Roll Number Validation

  • GET https://www.unifiedservices.co.uk/services/bankvaluk/refvalidate/userid/<userid>/pin/<pin>/sortcode/<sortcode>
    /account/<account>/reference/<reference>/<format>/
  • If http response code is < 200 or > 399 then call:-
  • GET https://www.unifiedsoftware.co.uk/services/bankvaluk/refvalidate/userid/<userid>/pin/<pin>/sortcode/<sortcode>
    /account/<account>/reference/<reference>/<format>/

where:

  • <userid> and <pin> are your user ID and 5 digit PIN obtained upon registration at:
    www.unifiedsoftware.co.uk/free-trial/free-trial-home.html
  • <sortcode> and <account> relate to the building society account.
  • <reference> is the building society reference to be validated.
  • <format> specifies the format of the returned data. Valid formats are csv, xml and json. (csv uses the "|" delimiter)

Results

If building society roll number is valid:-

  • The string VALID is returned

Example Valid Results

Sample valid response in xml format :-

<refvalidate>

  • <result>VALID<result>

</refvalidate>


Sample valid response in json format :-

  • {"result":"VALID"}

Sample valid response in csv format :-

  • VALID

If building society roll number is not valid or if an error occurs:-

  • Return field - contains an error message

Error messages :-

Error Messages

INVALID - Building Society Roll Number (Reference Number) is not valid.

ERROR - Invalid User ID/PIN - The User ID or PIN has not been recognised.

ERROR - UserID Expired - Trial user ID has expired.

ERROR - Insecure Connection - An attempt was made to access BankVal's refvalidate method using insecure HTTP protocol instead of HTTPS.


<< Back to Top >>


2 Roll Number - SOAP


Roll Number Validation functionality:

  • Validates a building society roll number (payment reference number) using validation rules specified by the building society.

Choose SOAP style:

There are two main ways of implementing SOAP, Document Literal and RPC. For help choosing the best solution for your implementation, please contact support@unifiedsoftware.co.uk.



<< Back to Top >>


2.1 Roll Number Validation - SOAP Document Literal


Roll Number Validation functionality:

  • Validates a building society roll number (payment reference number) using validation rules specified by the building society.

WSDL files

The WSDL file on the primary data centre is at https://www.unifiedservices.co.uk/services/bankvaluk/refvalidate.php?wsdl

The WSDL file on the backup data centre is at https://www.unifiedsoftware.co.uk/services/bankvaluk/refvalidate.php?wsdl


Request

Parameters

Description

userid

BankVal UK User ID.

pin

5 digit PIN.

sortcode

Sort code.

account

Bank Account number.

reference

Building society reference number to be validated.


Response

Field

Description

result

Result string contains on of the following messages:-
VALID - Building Society reference number (roll number) is valid.
INVALID - The building society reference number did not pass the validation cheks specified by the building society.
ERROR - Invalid User ID/PIN - The User ID or PIN has not been recognised.
ERROR - UserID Expired - Trial user ID has expired.
ERROR - Insecure Connection - An attempt was made to access BankVal's refvalidate method using insecure HTTP protocol instead of HTTPS.



<< Back to Top >>


2.2 Roll Number Validation - SOAP RPC


Roll Number Validation functionality:

  • Validates a building society roll number (reference number) using validation rules specified by the building society.

Parameter Format for Roll Number Validation

ReturnMessage = refvalidate(QueryString)

where

QueryString is a " | " delimited string of the format - "userid|PIN|sort code|account number|building society ref"

ReturnMessage is a " | " delimited string as shown below.

ReturnMessage meanings

VALID - Building society roll number (reference number) is valid.

INVALID - Building society roll number (reference number) does not comply with validation rules.

ERROR - Invalid User ID/PIN - The User ID or PIN has not been recognised.

ERROR - UserID Expired - Trial user ID has expired.

ERROR - Insecure Connection - An attempt was made to access BankVal's refvalidate method using the insecure HTTP protocol instead of HTTPS.


WSDL files

The WSDL file on the primary data centre is at https://www.unifiedservices.co.uk/bankvaluk3.wsdl

The WSDL file on the backup data centre is at https://www.unifiedsoftware.co.uk/bankvaluk3.wsdl


<< Back to Top >>