BWGetBranchData service

You use this service, after validating account details, to retrieve the branch address details. If the request is for a main branch, you can also retrieve the address details for any sub-branches.

To get the branch data, you must supply the data access key returned by BWValidate or BWValidateIBAN.

If you want to return sub-branch data, set returnSubBranches to true. If you do not supply this, the default (False) is used and no sub-branch data is returned.

This service returns:

subBranchesAvailable - if you did not set the returnSubBranches flag this shows whether sub-branches are available for these account details
branch data - this is returned for the main branch (subBranchNumber="0") and each available sub-branch (if you set the returnSubBranches flag). The data returned is:
- InstitutionName
- branchName
- address - made up of up to 5 addressLine, and postorzipcode,
- telephoneNumber.

SOAP messages

Request

<soapenv:Body>

<ns:BWGetBranchDataRequest language="en" returnSubBranches="false">

<eih:EIHHeader>

<eih:ClientUser>User</eih:ClientUser>

<eih:ReferenceId>123</eih:ReferenceId>

</eih:EIHHeader>

<ban:dataAccessKey>Data Access Key</ban:dataAccessKey>

</ns:BWGetBranchDataRequest>

</soapenv:Body>

Response

<SOAP-ENV:Body>

<eih:BWGetBranchDataResponse>

<header:EIHHeader>

<header:ClientUser>User</header:ClientUser>

<header:ReferenceId>123</header:ReferenceId>

</header:EIHHeader>

<bws:branchData subBranchNumber="0">

<bws:institutionName>070116 Short Name</bws:institutionName>

<bws:branchName>070116 Branch title - Absolute Test sortcode</bws:branchName>

<bws:address>

<bws:addressLine line="1">070116 Address 1</bws:addressLine>

<bws:addressLine line="2">070116 Address 2</bws:addressLine>

<bws:addressLine line="3">070116 Address 3</bws:addressLine>

<bws:addressLine line="4">070116 Town</bws:addressLine>

<bws:addressLine line="5">070116 County</bws:addressLine>

<bws:postOrZipCode>6506 6606</bws:postOrZipCode>

</bws:address>

<bws:telephoneNumber>67 070116 070116</bws:telephoneNumber>

</bws:branchData>

</eih:BWGetBranchDataResponse>

</SOAP-ENV:Body>