This guide is to assist in the integration of the sorting code and bank account validator into a website or application. The service definition can be viewed BankCheck Web Service and the full WSDL service description is available at WSDL service description.
Generally on a website we recommend you perform a GetBank in order to get the bank details, name address etc. If you are performing bank account validation for direct debits then you can check if a sortcode will allow direct debits by checking the flag 'PermitDebits'. This will be set to true if direct debits are allowed. It is also useful to allow the user to check their bank details. If you do not need or want to display the bank account details then performing a modulus check on its own is sufficient. It performs a Validate sortcode check on the fly as a modulus check is meaningless without knowing the sortcode is valid.The following table displays details of the methods in the API.
|Method Name||Description||Parameters||Example||Return Value|
|GetBank||Gets the bank details from the ISCD. Requires a sortcode as a parameter.||Sortcode||801021||Bank object|
|IsBankHoliday||This method checks to see if the date provided is a Bacs bank holiday. If the date is a bank holiday then the value returns a true, otherwise a false.||Date||25-Dec-2010||boolean|
|ModulusCheck||Performs a modulus check on a sortcode and bank account number. Requires a sortcode and account number as parameters.||Sortcode, Account number||801021, 00123456||boolean|
|ModulusCheckBatch||Performs a modulus check on an array of sortcodes and bank account numbers. The same array is returned but with the error element set to true or false depending on whether the bank account validation was successful or failed respectively.||Sortcode, Account number||801021, 00123456||boolean|
|ModulusCheckX||Performs a modulus check in the same way the ModulusCheck method does. However the extended version of the method takes a third parameter, namely refValue. This value is not validated in any way but is logged in our database so you can retrieve it later. Where this may be useful would be to record the direct debit reference number if you are performing modulus checking for direct debits.||Sortcode, Account Number, Reference||801021, 00123456, DD0012345||boolean|
|ValidateSortcode||Checks the sortcode exists in the ISCD. Requires a sortcode as a parameter.||Sortcode||801021||boolean|
The web service is a SOAP service and SOAP headers are used to authenticate the user of the service. The SOAP headers require two parameters: userId and password. Each of the developers guides shows a sample of how to create SOAP Headers.
Sort Code and bank account validation in a Visual Studio windows client application.This sample uses C#
|C# developers' guide|
Sortcode and bank account validation in AspUsing the API ASP.Net Web application
|ASP.Net C# developers' guide|
Sortcode and bank account validation in PHP
|PHP developers' guide|