Developers

GetBankDetails2

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 GetBankDetails2 - REST


GetBankDetails2 functionality:

  • Validates 8 character SWIFT Bank Identifier Codes (BICs) against the official SWIFTBIC database and if valid, returns bank branch information for the supplied SWIFT BIC.

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 GetBankDetails2

  • GET https://www.unifiedservices.co.uk/services/bankvalint/bankdetails2/userid/<userid>/pin/<pin>/swiftbic/
    <swiftbic>/<format>/
  • If http response code is < 200 or > 399 then call:-
  • GET https://www.unifiedsoftware.co.uk/services/bankvalint/bankdetails2/userid/<userid>/pin/<pin>/swiftbic/
    <swiftbic>/<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
  • <swiftbic> is the SWIFT Bank Identifier Code to be validated.
  • <format> specifies the format of the returned data. Valid formats are csv, xml and json. (csv uses the "|" delimiter)

Results

If SWIFT BIC is valid:-

  • First field - contains word VALID
  • Remaining fields - contain data from SWIFT BIC directory, i.e. SWIFTBIC|name1|name2|name3|address1|
    address2|address3|address4|location|country

Example Valid Results

Sample valid response in xml format :-

<swiftbic>

  • <result>VALID<result>
  • <bic>BARCGB21</bic>
  • <name1>BARCLAYS BANK</name1>
  • <name2></name2>
  • etc...

</swiftbic>


Sample valid response in json format :-

  • {"result":"VALID",
  • "bic":"BARCGB21",
  • "name1":"BARCLAYS BANK",
  • "name2":"",
  • etc...
  • }

Sample valid response in csv format :-

  • VALID|BARCGB21|BARCLAYS BANK||| etc... |

If SWIFT BIC is not valid or if an error occurs:-

  • First field - contains error message
  • xml, json - remaining fields are empty
  • csv - no other fields returned

Error messages :-

Error Messages

INVALID - The supplied SWIFT BIC does not exist.

INVALID - Result Format - Problem, with format field in URI.

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


<< Back to Top >>


2 Getbankdetails2 - SOAP


GetBankDetails2 functionality:

  • Validates 8 character SWIFT Bank Identifier Codes (BICs) against the official SWIFTBIC database and if valid, returns bank branch information for the supplied SWIFT BIC.

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 GetBankDetails2 SOAP - Document Literal

2.2 GetBankDetails2 SOAP - RPC


<< Back to Top >>


2.1 GetBankDetails2 - SOAP Document Literal


GetBankDetails2 functionality:

  • Validates 8 character SWIFT Bank Identifier Codes (BICs) against the official SWIFTBIC database and if valid, returns bank branch information for the supplied SWIFT BIC.

WSDL files

WSDL file on the primary data centre is https://www.unifiedservices.co.uk/services/bankvalint/getbankdetails2..php?wsdl

WSDL file on the backup data centre is https://www.unifiedsoftware.co.uk/services/bankvalint/getbankdetails2..php?wsdl


Request

Parameters

Description

userid

BankVal UK User ID.

pin

5 digit PIN.

swiftbic

8 character BIC to be validated.

Response

Field

Description

result

Result string contains on of the following messages:-
VALID - SWIFT BIC is valid.
INVALID - SWIFT BIC does not exist on SWIFT database.
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 getbankdetails2 method using insecure HTTP protocol instead of HTTPS.

bic

SWIFT Bank Identifier Code

name1

Name of institution - part 1

name2

Name of institution - part 2

name3

Name of institution - part 3

address1

Address of institution - part 1

address2

Address of institution - part 2

address3

Address of institution - part 3

address4

Address of institution - part 4

location

Address of institution - part 5

country

Address of institution - part 6


<< Back to Top >>


2.2 GetBankDetails2 - SOAP RPC


GetBankDetails2 functionality:

  • Validates 8 character SWIFT Bank Identifier Codes (BICs) against the official SWIFTBIC database and if valid, returns bank branch information for the supplied SWIFT BIC.

Parameter Format for GetBankDetails2

ReturnMessage = getbankdetails2(QueryString)

where

QueryString is a " | " delimited string of the format "userID|PIN|SWIFTBIC"

ReturnMessage is a string of 10 variable length fields delimited by " | " character. Please note that some of these fields may be empty.

All possible ReturnMessage values are shown below

ReturnMessage meanings

10 variable length fields in a "|" delimited string. - The fields are :- SWIFTBIC | name1 | name2 | name3 | address1 | address2 | address3 | address4 | location | country

INVALID - The supplied SWIFT BIC does not exist.

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 International's GetBankDetails2 service using insecure HTTP protocol instead of HTTPS.


WSDL files

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

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


<< Back to Top >>