Developers

Derive IBAN/BIC from UK sort code and account number

1. REST

2.1 SOAP Document Literal

2.2 SOAP RPC

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 Derive IBAN/BIC - REST


Derive IBAN/BIC functionality:

  • Converts a UK sort code and account number in domestic format into the equivalent International Bank Account Number (IBAN) and SWIFT Bank Identifier Codes (BICs).

To make sure you utilise our backup system, 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 Derive IBAN/BIC

  • GET https://www.unifiedservices.co.uk/services/bankvaluk/internationalise/userid/<userid>/pin/<pin>/sortcode/<sortcode>
    /account/<account>/<format>/
  • If http response code is < 200 or > 399 then call:-
  • GET https://www.unifiedsoftware.co.uk/services/bankvaluk/internationalise/userid/<userid>/pin/<pin>/sortcode/<sortcode>
    /account/<account>/<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> are the bank details to be converted
  • <format> specifies the format of the returned data. Valid formats are csv, xml and json. (csv uses the "|" delimiter)

Results

If sort code and account number are valid:-

  • The string VALID is returned, accompanied by the IBAN and BICs

Example Valid Results

Sample valid response in xml format :-

<internationalise>

  • <result>VALID<result>
  • <iban>GB60NWBK60155112345678</iban>
  • <bacsbic>NWBKGB2110T</bacsbic>
  • <chapssbic>NWBKGB55123</chapssbic>
  • <chapsebic></chapsebic>

</internationalise>


Sample valid response in json format :-

  • {"result":"VALID",
  • "iban":"GB60NWBK60155112345678",
  • "bacsbic":"NWBKGB5510T",
  • "chapssbic":"NWBKGB55123",
  • "chapsebic":"",
  • }

Sample valid response in csv format :-

  • VALID|GB60NWBK60155112345678|NWBKGB5510T|NWBKGB21123||

If sort code and/or account number are not valid or if an error occurs:-

  • Result field - contains error message

Error messages :-

Error Messages

INVALID - Sortcode - The supplied sort code does not exist in the VocaLink Extended Industry Sorting Code Directory (EISCD).

INVALID - Account - The supplied account number is not in any of the recognisable formats, i.e. 7 - 10 numeric characters in length.

INVALID - Modulus Check Failed - The sort code and/or account number failed the modulus check(s) specified by the holding bank.

INVALID - Result Format - format parameter was not ‘xml’, ‘json’ or ‘csv’

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 Internationalise method using insecure HTTP protocol instead of HTTPS.


<< Back to Top >>


2 Derive IBAN/BIC - SOAP


Derive IBAN/BIC functionality:

  • Converts a UK sort code and account number in domestic format into the equivalent International Bank Account Number (IBAN) and SWIFT Bank Identifier Codes (BICs).

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.


2.1 Derive IBAN/BIC SOAP - Document Literal

2.2 Derive IBAN/BIC SOAP - RPC


<< Back to Top >>


2.1 Derive IBAN/BIC - SOAP Document Literal


Derive IBAN/BIC functionality:

  • Converts a UK sort code and account number in domestic format into the equivalent International Bank Account Number (IBAN) and SWIFT Bank Identifier Codes (BICs).

WSDL files

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

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


Request

Parameters

Description

userid

BankVal UK User ID.

pin

5 digit PIN.

sortcode

Sort code to be converted.

account

Account number to be converted.

Response

Field

Description

result

Result string contains on of the following messages:-
VALID - All checks on sort code and account number passed successfully.
INVALID Sortcode - The supplied sort code does not exist in the VocaLink Extended Industry Sorting Code Directory (EISCD).
INVALID - Account - The supplier account is not in any recognisable formats, i.e. 7 - 10 numeric character in length.
INVALID - Modulus Check Failed - The sort code / account number combination did not pass the modulus checks specified by the owning bank.
ERROR - Invalid User ID/PIN - The User ID or PIN has not been recognised.
ERROR - User ID Expired - Trial user ID has expired.
ERROR - Insecure Connection - An attempt was made to access BankVal's internationalise method using insecure HTTP protocol instead of HTTPS.

iban

International Bank Account Number

bacsbic

SWIFT BIC for Bacs clearing

chapssbic

SWIFT BIC for CHAPS sterling clearing

chapsebic

SWIFT BIC for CHAPS euro clearing


<< Back to Top >>


2.2 Derive IBAN/BIC - SOAP RPC


Derive IBAN/BIC functionality:

  • Converts a UK sort code and account number in domestic format into the equivalent International Bank Account Number (IBAN) and SWIFT Bank Identifier Codes (BICs).

Parameter Format for Derive IBAN/BIC

ReturnMessage = internationalise(QueryString)

where :

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

ReturnMessage is a " | " delimited string or an error message, as shown below.

ReturnMessage Meaning:

If the sort code and account number are valid, the response from internationalise will be:

  • <IBAN>|<BACSBIC>|<CHAPSSTERLINGBIC>|<CHAPSEUROBIC>|
  • Example: ‘GB60NWBK60155112345678|NWBKGB2110T|NWBKGB55123||’

Note that the CHAPS Euro BIC is currently returned empty, but the field is included for future compatibility.

INVALID - Modulus Check Failed - The sort code and/or account number failed the modulus check(s) specified by the holding bank.

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 Internationalise 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 >>