Developers

GetABADetails

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 GetABADetails - REST implementation


The GetABADetails service performs the following functions:

  • Validates any USA ABA Routing Number.
  • If ABA number is valid, returns bank information.

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 GetABADetails

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

Results

If aba is valid:-

  • First field - contains word VALID
  • Remaining fields - contain data about the bank i.e. Routing Number | Bank Name | Bank Address |
    City | State | ZIP Code | Phone Number | Area Code | FIPS | Time Zone | DST | Latitude |
    Longitude | MSA | PMSA | County

Example Valid Results

Sample valid response in xml format :-

<aba>

  • <result>VALID<result>
  • <routingnumber>122105906</routingnumber>
  • <bankname>1ST BANK YUMA</bankname>
  • <bankaddress>2799 S. 4TH AVE</bankaddress>
  • <city>YUMA</city>
  • etc...

</aba>


Sample valid response in json format :-

  • {"result":"VALID",
  • "routingnumber":"122105906",
  • "bankname":"1ST BANK YUMA",
  • "bankaddress":"2799 S. 4TH AVE",
  • "city":"YUMA",
  • etc...
  • }

Sample valid response in csv format :-

  • VALID|122105906|1ST BANK YUMA|2799 S. 4TH AVE|YUMA| etc...

If routing number 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 ABA Routing Number in not valid.

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


<< Back to Top >>


2 GetABADetails - SOAP


GetABADetails functionality:

  • Validates any USA ABA Routing Number.
  • If ABA number is valid, returns bank information.

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

2.2 GetABADetails SOAP - RPC


<< Back to Top >>


2.1 GetABADetails - SOAP Document Literal


GetABADetails functionality:

  • Validates any USA ABA Routing Number.
  • If ABA number is valid, returns bank information.

WSDL files

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

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


Request

Parameters

Description

userid

BankVal UK User ID.

pin

5 digit PIN.

aba

9 digit routing number.

Response

Field

Description

result

Result string contains on of the following messages:-
VALID - ABA Routing Number is valid.
INVALID - ABA Routing Number is not valid.
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 getabadetails method using insecure HTTP protocol instead of HTTPS.

routingnumber

Routing Number

bankname

Name of bank

bankaddress

Address of bank - part 1

city

Address of bank - part 2

state

Address of bank - part 3

zipcode

Address of bank - part 4

telephone

Contact telephone number - part 1

areacode

Contact telephone number - part 2

fips

Contact telephone number - part 3

timezone

timezone

dst

Daylight saving adjustment

latitude

Location

longitude

Location

msa

pmsa

county



<< Back to Top >>


2.2 GetABADetails - SOAP RPC


The GetABADetails service performs the following functions:

  • Validates any USA ABA Routing Number.
  • If ABA number is valid, returns bank information.

Parameter Format for GetABADetails

ReturnMessage = getabadetails(QueryString)

where

QueryString is a " | " delimited string of the format "userID|PIN|ABA Routing Number"

ReturnMessage is either the string "INVALID" OR "ERROR - ..." OR

a 17 field string that is delimited by " | " characters in the format :-

VALID | Routing Number | Bank Name | Bank Address | City | State | ZIP Code | Phone Number | Area Code | FIPS | Time Zone | DST | Latitude | Longitude | MSA | PMSA | County

All possible ReturnMessage values are shown below

ReturnMessage meanings

17 field string as described above. - This is returned as a " | " delimited character string.

INVALID - The supplied ABA Routing Number in 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 International's GetABADetails 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 >>