Home

Directories Web Services

1. e http www swift com solutions messaging information products image doc bicdirectory ws dl for BIC Directory Web Service e http www swift com solutions messaging information products image doc ibandirectory w sdl for BICPlusIBAN Directory Web Service Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification_Webservices_v2_2 1 docx Page 37 4 2 3 1 Code PERE SEARIOLER EEE SESE REE EER ER EELS SEER ERASE CE RESES EE SAAR KAKIA LAER ARES EERE Copyright C S W I F T sc 2009 All rights reserved HEELEEERE REARS AER EREAERNEREE AREER AREA SES ERKEEERERARS EERE REARS EE EE SE ERS REREE Sf import java util Map import javax xml ws BindingProvider import com sun xml ws client ClientTransportException import com swift ws bicdirectory client BicDetails import com swift ws bicdirectory client BicDirectoryW S import com swift ws bicdirectory client BicDirectoryW SService import com swift ws ibandirectory client lbanDirectoryWS import com swift ws ibandirectory client lbanDirectoryWSService fre Class to test the SWIFT com BicDirectory WebServices This is to test the JAX WS client implementation to access the SWIFT com Directories WebServices As the HTTP Client of the JAX WS implementati
2. INVALID The supplied BIC does not exist or The supplied BIC exists but is not valid for the specified context INVALIDLICENSE You do not have enough privileges to execute this service To be allowed for this service you must have a valid subscription to the Directory product ERRORCONTEXT The specified context in the input parameters is not correct 3 4 5 GetAddress 3 4 5 1 GetAddress service performs the following functions e Checks that the 11 character BIC exists in the BIC Directory and if yes it returns the address for the supplied BIC e If an 8 character BIC is provided then XXX is automatically added as branch code e Note that the unpublished BICs are not considered as valid e Returns a information message Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public InterfaceSpecification Webservices_v2_2 1 docx Date 26 May 2010 Page 10 3 4 5 2 Parameter Format for GetAddress ReturnMessage getAddress String arg0 Where Input Parameters Parameter Description argO lt bic gt is the BIC to be validated Return Message Return Message Description Object Object Name BicDetails Attributes e result e bicCode e branchCode e institutionName branchinformation e cityHeading e countryCode e subTyp
3. www2 swift com crdpws bicdirectory IBAN Directory Web Service https www2 swift com crdpws ibandirectory 4 4 2 PERL Code perl w use HTTP Cookies use SOAP Lite sub SOAP Transport HTTP Client get_ basic credentials return YourUserName gt YourPassWord print BICDIRECTORY Service is SOAP Lite gt proxy https www2 swift com crdpws bicdirectory cookie jar gt HTTP Cookies gt new ignore discard gt 1 gt uri https ws swift com gt getStatus gt result print n y print yn my SbicCode SOAP Data gt type string gt name arg0 gt ABNANL2A my Sservice SOAP Lite gt proxy https www2 swift com crdpws bicdirectory cookie jar gt HTTP Cookies gt new ignore discard gt 1 gt uri https ws swift com my result Sservice gt getAddress SbicCode gt result foreach my key keys Sresult print key Sresult gt Skey n Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification_Webservices_v2_2 1 docx Page 43 4 5 Writing a Web Service NET Client This sample is written with the following version Visual Studio 2008 NET 2 0 4 5 1 HTTPS Protocol Directories Web Services is ac
4. your user name String password your password IbanDirectoryWSServiceStub stub new lbanDirectoryWSServiceStub addHttpBasicAuthentication stub username password This sample check the lbanDirectory WebService getDetailsFromNationalld String countryCode String nationalld Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification_Webservices_v2_2 1 docx Page 35 GetDetailsFromNationalld nationalld new GetDetailsFromNationalld nationalld setArgO RU Country Code nationalld setArg1 44583892 National Id GetDetailsFromNationalldE nationalldE new GetDetailsFromNationalldE nationalldE setGetDetailsFromNationalld nationalld GetDetailsFromNationalldResponseE responseE stub getDetailsFromNationalld nationalldE if responseE null GetDetailsFromNationalldResponse response responseE getGetDetailsFromNationalldResponse NationalldDetails nationalldDetails response get_return if nationalldDetails null amp amp VALID equals nationalldDetails getResult System out printin Institution Name nationalldDetails getInstitutionName System out printIn City Heading nationalldDetails getCityHeading System out printIn Bic Code n
5. exception oh if The server sent HTTP status code 401 Unauthorized equals ex getLocalizedMessage r At this stage you can start your Web Service calls This sample check the BicDirectory WebService getAddress String bic Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification_Webservices_v2_2 1 docx Page 39 BicDetails details bicDirectoryWS getAddress SOGEFRPP if details null amp amp VALID equals details getResult System out printIn Bic Code details getBicCode System out printIn Branch Code details getBranchCode System out printin Institution Name details getinstitutionName else throw ex finally jee Sets the username the password and the session_maintain_property in the header param bicDirectoryWS 5 private static void addHttpBasicAuthentication BicDirectoryWS bicDirectoryWS String userName String password Map lt String Object gt request BindingProvider bicDirectoryWS getRequestContext Must be true to re inject the cookies I request put BindingProvider SESSION_MAINTAIN_PROPERTY true request put BindingProvider USERNAME_PROPERTY userName request put BindingProvider PASSWO
6. May 2010 InterfaceSpecification_Webservices_v2_2 1 docx Page 7 directory product ERRORCONTEXT See details below in each service description INVALIDCOUNTRY See details below in each service description UNLISTEDCOUNTRY INVALIDIBANCOUNTRY See details below in each service description ERRORIBANLENGTH See details below in each service description See details below in each service description ERRORCHECKDIGITS See details below in each service description INVALIDNATIONALID See details below in each service description INVALIDBIC See details below in each service description INVALIDBIC1 See details below in each service description INVALIDCOMBINATION See details below in each service description NOMATCHING See details below in each service description INVALIDDATE See details below in each service description OTHERERROR An unknown exception occurs for example inputing a parameter of length greater than 32000 characters 3 4 Web Service for the BIC Directory All the queries access the Live SWIFT BIC Directory which is daily updated This assumes that the queries get always the latest SWIFT BIC Directory data 3 4 1 WSDL file The WSDL file is located in our SWIFT com public site http www swift com solutions messaging information products image doc bicdirectory wsdl 3 4 2 BICDirectoryWSService version 1 1 Ser
7. OW icicle a eee ee dn ces ee 5 3 2 Authentication and Authorization c ccccccceceeeeeeenaeceeeeeeeeecaeaeceeeeeeesennanaeeeeees 5 3 2 1 SWIFT com Username restrictions 20 0 ceeeeeeeseceeeeeeeeeeeeneeeees 6 3 3 Web Service Return Message ccccccceeceeeeeceeeeeceneeeeeaeeeeeeeseeeesaeeeeneeseeeeees 6 Sel AROUMIT Messaer oreen aauirosn tua stte weigh seca eg E meee 6 3 3 2 List f result COGS i a te eet te ae iS 6 3 4 Web Service for the BIC Dire CtOry cccceceeseeeceeeeeeeneeeeaeeeeeeeseeeeseaeeeeneeteneees 7 SAM WSDEfe oninia e e A E 7 3 4 2 BICDirectoryWSService version 1 1 eee eeeeeeeeeeeneeeneeees 7 SA3 GetStats sennen n E aE o Asians 8 JAA ValdateBi s ereinen aa a ade ee 8 JAI G tAddrESS nienn e erann oE E EEE ESEE 9 3 4 6 GetListOfDeletedBic siccsscaseceiasratesacassutesdsa qeadsevahvensaeegoseaneseens 11 SA GetListOfAddedBic cni eea iR 13 3 5 Web Service for the BICPlusIBAN Directory ccccceeseeeeeeeeseeeeeeeeeeeeeeeees 15 SOA WSDE Tile ais vescrancissaecisapendneijuaarnsuniadetdasodacastesadetenstaetssendaa de ees 15 3 5 2 IbanDirectoryWSService version 1 0 0 0 eeeeeeeeeeeeteeeeeeees 15 Jo OCIS ALIS Suara cattails ui ane re ane 16 S54 Validate Nation ale i is irtete teite 16 3 39 Validate Da e ote ec ee N 18 3 5 6 Validatelban Bic n i scriniis iin niii bisino 19 33 7 GetDetailsFromB IC ea n A N A E 21 3 5 8 GetDetailsFromNationall
8. chipsUid gt lt chipsUid gt lt physicalAddress1 gt lt physicalAddress1 gt lt physicalAddress2 gt lt physicalAddress2 gt lt physicalAddress3 gt lt physicalAddress3 gt lt physicalAddress4 gt lt physicalAddress4 gt lt zipCode gt lt zipCode lt location gt lt location lt countryName gt lt countryName gt nationalldDetails gt The attribute result code meanings Result Code Description VALID The supplied CHIPS UID exists in the BICPlusIBAN Directory INVALID The supplied CHIPS UID does not exist in the BICPlusIBAN Directory INVALIDLICENSE You do not have enough privileges to execute this service To be allowed for this service you must have a valid subscription to the Directory product 3 5 10 DeriveBicFromliban 3 5 10 1 DeriveBicFromlban service performs the following functions e Validates any supplied IBAN according to the following criteria Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification_Webservices_v2_2 1 docx Page 27 e Validate first if IBAN is correct e Validate that the BIC is correct e Derive from the given IBAN the BIC issued with this IBAN For how to derive the BIC from an IBAN see the BICPlusIBAN Directory Techni
9. meanings Result Code Description VALID At least of one deleted BIC has been found in the BIC Directory INVALID No result has been found INVALIDDATE The from date or to date is invalid INVALIDLICENSE You do not have enough privileges to execute this service To be allowed for this service you must have a valid subscription to the Directory product 3 4 7 GetListOfAddedBic 3 4 7 1 GetListOfAddedBic service performs the following functions e Checks if the period has been defined by a from date and a to date The from date is mandatory The to date is not mandatory e Returns the list of added BICs for the period defined by the from date and to date 3 4 7 2 Parameter Format for GetListOfAddedBic ReturnMessage getListOfAddedBic Date arg0 Date arg1 Where Input Parameters Parameter Description argO lt fromDate gt is the from date This parameter is mandatory arg1 lt toDate gt is the to date If this parameter is left empty null the to date will be the current date of the day Return Message Return Message Description List of Object Object List BicDetailsList Attributes Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May
10. string Format Branch Code 0 lt br gt nationalIdDtls branchCode Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification_Webservices_v2_2 1 docx Page 45 Response Write string Format City Heading 0 lt br gt nationalIdDtls cityHeading Response Write string Format Institution Name 0 lt br gt nationalIdDtls institutionName else Response Write Not all web services are running catch Exception e Response Write e StackTrace Revision record Revision Date Author Description Sections affected 1 0 27 11 2009 W Y Joiris Final All 2 1 26 05 2010 W Y Joiris Add two new services 3 4 2 3 4 6 3 4 7 for BIC directory End of document Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT
11. 2010 InterfaceSpecification_Webservices_v2_2 1 docx Page 14 e result e list List Of BicDetails Object Name BicDetails Attributes e result e bicCode e branchCode e _institutionName branchinformation e cityHeading e countryCode e subType e valueAddedServices e extralnformation e physicalAddress1 e physicalAddress2 e physicalAddress3 e physicalAddress4 e location e countryName lt bicDetailsList gt lt resulb lt result gt lt list gt lt bicDetails cresult gt lt result gt lt bicCode gt lt bicCode lt branchCode gt lt branchCode lt InstitutionName gt lt institutionName lt branchInformation gt lt branchInformation gt lt cityHeading gt lt cityHeading gt lt countryCode gt lt countryCode lt subT ype gt lt subT ype valueAddedServices gt lt valueAddedServices gt lt extralnformation gt lt extralnformation lt physicalAddress1 gt lt physicalAddress1 gt lt physicalAddress2 gt lt physicalAddress2 gt lt physicalAddress3 gt lt physicalAddress3 gt lt physicalAddress4 gt lt physicalAddress4 lt location gt lt location gt lt countryName gt lt countryName gt lt bicDetails lt bicDetails lt bicDetails gt lt bicDetails gt lt bicDetails gt lt bicDetails gt lt bicDetails gt lt list gt lt bicDetailsList gt XML Copyright S W I F T SCRL 2010 All rights reserved The information herein i
12. Confidentiality Public Date 26 May 2010 InterfaceSpecification_Webservices_v2_2 1 docx Page 1 Messaging Interface Specification for Directories Web Services Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification_Webservices_v2_2 1 docx Page 2 Confidentiality Public Status Final Author Woo Yo Joiris Path Reviewers Approver s Copy to Hugues Bernard Zino Khouani Raquel Clemente Christophe Bolle Paul Janssens Marc Rosso Benoit Pirotte Jurgen Vijverman Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification_Webservices_v2_2 1 docx Page 3 Table of contents 1 PUPP OSC ooo coe caesar cca A a 5 2 PROTA CO sicesscatiisstes aicces statditui tosscasdauinccuseiuvacustanaa E 5 2 1 Purpose OF THIS Gude sive tian shes sce dees bi ani A A A EER 5 2 2 Related publication essaie a aa i E ERS U EREE EER 5 3 Interface Description s eccccsseeeceesseeeeeensceeseenseeeeenseeeeeensneeeeenseeeeeenseeeeeenseeeeeenseeneeenss 5 3 1 OVENI
13. ERE AERA EARS import org apache axis2 AxisFault import org apache axis2 client Options Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification_Webservices_v2_2 1 docx Page 34 import org apache axis2 transport http Http TransportProperties import com swift ws lbanDirectoryW SServiceStub import com swift ws lbanDirectoryW SServiceStub GetDetailsFromNationalld import com swift ws lbanDirectoryW SServiceStub GetDetailsFromNationalldE import com swift ws lbanDirectoryW SServiceStub GetDetailsFromNationalldResponse import com swift ws lbanDirectoryW SServiceStub GetDetailsFromNationalldResponseE import com swift ws lbanDirectoryW SServiceStub NationalldDetails je Class to test the SWIFT com BicPlusIBAN Directory WebServices This is to test the AXIS2 client implementation to access the SWIFT com Directories WebServices As the AXIS2 implementation uses Common HTTP Client of apache you have to set parameters to be compliant with the SWIFT com security policy The POST method encoding cannot use the chunked encoding and the BASIC authentication must be re active author wioiris public class BicWebServiceTest public static void main String args throws Exception try String username
14. HP language PHP with PEAR SOAP package NET language NET 2 0 with Visual Studio For more information see the Axis2 Apache website http ws apache org axis2 see JAX WS Reference Implementation https jax ws dev java net see the PEAR site http pear php net package SOAP see the NET site http msdn microsoft com en us netframework default aspx 4 2 Writing a Web Service Java Client 4 2 1 HTTPS Protocol As our Directories Web Services is accessible through HTTPS protocol the virtual machine of your JAVA client should trust the SWIFT com certificate and thus you should import the SWIFT com certificate in your JRE In the following example SWIFT CA is used as the root certificate keytool import keystore S JAVA_HOME jre lib security cacerts storepass PASS alias SWIFT CA file SCERTFILE 4 2 2 Code Client with Axis2 First you have to generate the code client based on the Directories Web Services WSDL e http www swift com solutions messaging information products image doc bicdirectory ws dl for BIC Directory Web Service e http www swift com solutions messaging information products image doc ibandirectory w sdl for BICPlusIBAN Directory Web Service 4 2 2 1 Code ORR EN ERENT EEE EEE EEE TAIN EAD EE PONE EAS LAA ASS Ree RN Ree eae Copyright C S W I F T sc 2009 All rights reserved RATERAEAE AREAS RESIN SER EERERESESER SEAT R PRESEN SEA ERED AIAR ERASE AERA E
15. ID The supplied BIC does not exist in the BICPlusIBAN Directory INVALIDLICENSE You do not have enough privileges to execute this service To be allowed for this service you must have a valid subscription to the Directory product NOMATCHING The supplied BIC exists but it does not match to a NATIONAL ID in the BICPlusIBAN Directory Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification Webservices_v2_2 1 docx Page 30 3 5 12 LinkNationalld 3 5 12 1 LinkNationalld service performs the following functions e Checks that the NATIONAL ID from a specific country exists in the BICPlusIBAN Directory and if yes it returns the 11 character BIC for the supplied code e Make a search on the fields COUNTRY CODE and UNIQUE NATIONAL ID e Returns a information message 3 5 12 2 Parameter Format for LinkNationalld ReturnMessage linkNationalld String arg0 String arg1 Where Input Parameters Parameter Description argO lt country is the Country Code for which the national code has to be validated corresponds to field COUNTRY CODE in BICPlusIBAN argi nationalid gt is the National Code to be validated corresponds to field UNIQUE NATIONAL ID in BICPlusIBAN Return Message Return Mess
16. If an 8 character BIC is provided then XXX is automatically added as branch code e Note that the unpublished BICs are not considered as valid e Returns a validation message 3 4 4 2 Parameter Format for ValidateBic ReturnMessage validateBic String argO String arg1 Where Input Parameters Parameter Description argO lt bic gt is the BIC to be validated context specifies the context in which the user wants to validate the BIC The following values can be used e FINHEADER Check that the BIC is valid for the header of a FIN message arg1 e FINBODY Check that the BIC is valid for the body of a FIN message e NONE Check that the BIC exists the context has no importance Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification Webservices_v2_2 1 docx Page 9 Return Message Return Message Description Object Object Name BicContext Attributes result bicCode branchCode context XML bic lt resulb lt result gt lt bicCode gt lt bicCode lt branchCode gt lt branchCode lt context gt lt context lt bic The attribute result code meanings Result Code Description VALID The supplied BIC is valid for the specified context
17. RD_PROPERTY password Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification_Webservices_v2_2 1 docx Page 40 4 3 Writing a Web Service PHP Client This sample is written with the following version PHP 5 3 1 PEAR 1 8 0 PEAR SOAP 0 12 0 PEAR HTTP_Request 1 4 4 PEAR Net_URL 1 07 4 PEAR Net_Socket 1 0 12 4 3 1 HTTPS Protocol As our Directories Web Services is accessible through HTTPS protocol the PHP client can verify the certificate or can bypass the verification In the following example we choose to bypass the verification 4 3 2 WSDL The Directories Web Services WSDL e BIC Directory Web Service http www swift com solutions messaging information products image doc bicdirectory ws dl e IBAN Directory Web Service http www swift com solutions messaging information products image doc ibandirectory w sdl But in the following example as the PEAR SOAP WSDL version is not compatible with our WSDL the example uses the ENDPOINT and the NAMESPACE 4 3 2 1 Directories Web Services NAMESPACE BIC Directory Web Service https ws swift com IBAN Directory Web Service https ws swift com 4 3 2 2 Directories Web Services ENDPOINT BIC Directory Web Service https www2 swift c
18. age Description Object Object Name LinkBic Attributes result bicCode e branchCode e countryCode e nationalld e specialCode dinkBic gt lt resulb lt result lt bicCode gt lt bicCode lt branchCode gt lt branchCode gt lt countryCode gt lt countryCode lt nationalld gt lt nationalld gt lt specialCode gt lt specialCode lt linkBic The attribute result code meanings Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification Webservices_v2_2 1 docx Page 31 Result Code Description VALID National ID for the country is found and a BIC is matched the field BIC CODE is not empty INVALID The supplied National ID does not exist in the BICPlusIBAN Directory for this country INVALIDLICENSE You do not have enough privileges to execute this service To be allowed for this service you must have a valid subscription to the Directory product INVALIDCOUNTRY The Country Code of the supplied Country Code does not exist example ZZ Must be validated against the list of ISO country code CT file UNLISTEDCOUNTRY The national codes of this country are not listed in the BICPlusIBAN Directory NOMATCHING The supplied NATIONAL ID exists for this country bu
19. anaged as the Basic HTTP Authentication method used by SWIFT is non pre emptive method and cookie based Please note also that our SWIFT com infrastructure does not allow the chunked encoding in the POST method 3 2 1 SWIFT com Username restrictions The SWIFT com Username used for the basic authentication cannot be a multi profile SWIFT com Username 3 3 Web Service Return Message All services in their return message have always a result attribute This result attribute is the main information about the status of the service execution 3 3 1 Return Message Return Message Description Object Object Name Object Attributes e result e lt object lt result lt result gt lt object gt 3 3 2 List of result code Result Code Description VALID If the service request is valid See details below in each service description VALIDOTHER If the service request is valid See details below in each service description INVALID If the service request is invalid See details below in each service description INVALIDLICENSE You do not have enough privileges to execute this service To be allowed for this service you must have a valid subscription to the Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26
20. ationalldDetails getBicCode System out printIn Branch Code nationalldDetails getBranchCode catch AxisFault fault fault printStackTrace je Sets the BasicAuthentication object and the chunked_property in the header Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification_Webservices_v2_2 1 docx Page 36 param lbanDirectoryWSServiceStub I private static void addHttpBasicAuthentication IbanDirectoryWSServiceStub stub String userName String password HttpTransportProperties Authenticator basicAuthentication new HttpTransportProperties Authenticator basicAuthentication setUsername userName basicAuthentication setPassword password I Reactive basic authentication I basicAuthentication setPreemptiveAuthentication false Options options stub _getServiceClient getOptions options setProperty org apache axis2 transport http HT TPConstants AUTHENTICATE basicAuthentication SWIFT Does not allow CHUNKED Encoding in the POST method options setProperty org apache axis2 transport http HT TPConstants CHUNKED false 4 2 3 Code Client with JAX WS First you have to generate the code client based on the Directories Web Services WSDL
21. ban The attribute result code meanings Result Code Description VALID IBAN is valid According to the 4 criteria Note that we do not check the account number INVALIDLICENSE You do not have enough privileges to execute this service To be allowed for this service you must have a valid subscription to the Directory product INVALIDCOUNTRY The Country Code within the supplied IBAN is not valid Example ZZ Is validated against the list of ISO country code CT file INVALIDIBANCOUNTRY The Country Code exists but is not registered in the IBAN Registry example ZW Is validated against the field IBAN COUNTRY CODE in the BICPlusIBAN Directory IS file gt Previous condition INVALIDCOUNTRY is checked first UNLISTEDCOUNTRY The Country Code is registered in the IBAN Registry but the national codes of this country are not listed in the BICPlusIBAN Directory ERRORCHECKDIGITS The IBAN failed the modulus check they are calculated based on the scheme defined in ISO IEC 7064 Modulo 97 10 INVALIDNATIONALID The country is listed but the supplied IBAN NATIONAL ID retrieved from the IBAN does not exist in the BICPlusIBAN Directory for this country it does not mean that the code does not exist in absolute ERRORIBANLENGTH The length of the supplied IBAN is not correct for this country 3 5 6 Validatelban Bic 3 5 6 1 ValidatelbanBic service performs the fol
22. cal Specifications Please note that an IBAN must be provided in its electronic format e print format CZ94 5500 0000 0010 1103 8930 e electronic format CZ945500000000101 1038930 e It will be up to the user to convert to the electronic format first i e remove blank spaces e Returns a information message 3 5 10 2 Parameter Format for DeriveBicFromliban ReturnMessage deriveBicFromlban String arg0 Where Input Parameters Parameter Description argO lt ibam is the IBAN to be validated Note that IBANs have the same formats in a given country but the formats can be different from country to country These formats are defined in the IBAN Registry SWIFT is the ISO registrar The IS file of the BICPlusIBAN directory also provides a machine readable list of the IBAN formats Return Message Return Message Description Object Object Name IbanBic Attributes e result e iban e ibanBicCode e ibanBranchCode lt ibanBic lt result lt result lt iban gt lt ibanm lt ibanBicCode gt lt ibanBicCode gt lt ibanBranchCode gt lt ibanBranchCode lt ibanBic gt XML Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification Webservices_v2_2 1 docx Page 28 The attrib
23. cessible through HTTPS protocol but as the NET client is running in a WEB Application there is no specific setting to do 4 5 2 Code Client with NET First you have to generate the code client based on the Directories Web Services WSDL e http www swift com solutions messaging information products image doc bicdirectory ws dl for BIC Directory Web Service e http www swift com solutions messaging information products image doc ibandirectory w sdl for BICPlusIBAN Directory Web Service 4 5 3 Code using System using System Collections Generic using System Web using System Web UI using System Web UI WebControls using System Net using SWIFTWS public partial class Default System Web UI Page protected void Page Load object sender EventArgs ea try Setup cookie container CookieContainer cookieContainer new CookieContainer Setup network credentials NetworkCredential networkCredential new NetworkCredential username password Instantiate the IbanDirectory Web Service IbanDirectoryWSService ibanDirectoryWSService new IbanDirectoryWSService Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification _Webservices_v2_2 1 docx Page 44 ibanDirector
24. d sc c coc gnedilontictiendnaieealion 23 3 5 9 GetDetailsPromChips Vid cissssasicvesscadsesstdeduvssasadeces stesantecseencees 25 33 10 UOeTIVERICPLOMUBDAN nessies ai 26 SAL VANKBIC tajsiccavs sceawtavdaadsadnccac sa segaae nnna a i 28 Sole EmkNationalld pestat rau a E EERE E 30 Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification_Webservices_v2_2 1 docx Page 4 S25 19 ASI COMME CEE BCs eaei 31 4 COOK BOOK 5s 2 2 sisccees r r cces ace ta obec a a aE aE rea eA pa lt tc Aaen ASTAL E nectar 32 4 1 laiigolo 80 fo a M A ET EA TE TET 32 4 2 Writing a Web Service Java Client 2 0 ce ccecececececeeeeeeeneeeesaeseeeeeseaeeesaeeeeneeeeaees 33 A2 HETES Protocol secas enn a a a S a 33 4 2 2 Code Client with Axis2 25 tasisntassiesactauiiectesnteeteasnavantedebeneeelnes 33 423 Code Client with JAR W Sie piaceisteeidiaschaat itucndocderditecasasian 36 4 3 Writing a Web Service PHP Client ccceesceceeeeeeeneeeeaeeseeeeeceaeeesaeeeeneeenaees 40 ADA HETES Protocols i t re eteti Gea ches tess a a i 40 4 3 2 WSDL ore re beaut cassie nghes e a a aos bed Sees a Gaai 40 AIS 0 PPA GUC ea a A aa 40 4 4 Writing a Web Service PERL Client 0 0 cececceeeceeceeeeeeeeeeeeeeeseeeeeeaeeeeneeenaees 41 AAA WSDLeitrssr
25. e e valueAddedServices e extralnformation e physicalAddress1 e physicalAddress2 e physicalAddress3 e physicalAddress4 e location e countryName lt bicDetails lt resulb lt result gt lt bicCode gt lt bicCode lt branchCode gt lt branchCode gt lt institutionName gt lt institutionName gt lt branchInformation gt lt branchInformation lt cityHeading gt lt cityHeading lt countryCode gt lt countryCode lt subType gt lt subT ype valueAddedServices gt lt valueAddedServices gt lt extralnformation gt lt extralnformation gt lt physicalAddress1 gt lt physicalAddress1 gt XML Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification Webservices_v2_2 1 docx Page 11 lt physicalAddress2 gt lt physicalAddress2 gt lt physicalAddress3 gt lt physicalAddress3 gt lt physicalAddress4 gt lt physicalAddress4 lt location gt lt location lt countryName gt lt countryName gt lt bicDetails The attribute result code meanings Result Code Description VALID The supplied BIC exists in the BIC Directory INVALID The supplied BIC does not exist in the BIC Directory INVALIDLICENSE You do not have enough privileges to execute this
26. ecks that the 11 character BIC exists in the BICPlusIBAN Directory and if yes it returns the NATIONAL ID for the supplied BIC e If an 8 character BIC is provided then XXX is automatically added as branch code e Note that the unpublished BICs are not considered as valid e Makes a search on the field UNIQUE BIC CODE UNIQUE BRANCH CODE e Returns a information message 3 5 11 2 Parameter Format for LinkBic ReturnMessage linkBic String arg0 Where Input Parameters Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification Webservices_v2_2 1 docx Page 29 Parameter Description argO bic is the BIC to be validated Return Message Return Message Description Object Object Name LinkBic Attributes e result e bicCode e branchCode e countryCode e nationalld e specialCode dinkBic lt result lt result gt lt bicCode gt lt bicCode lt branchCode gt lt branchCode lt countryCode gt lt countryCode lt nationalld gt lt nationalld gt lt specialCode gt lt specialCode lt linkBic XML The attribute result code meanings Result Code Description VALID The supplied BIC exists in the BICPlusIBAN Directory and a match to a national ID is found INVAL
27. getStatus Where ReturnMessage is a String RUNNING the Web Service is up and running ERROR the Web Service is up and running but cannot access the Database INVALIDLICENSE the Web Service is up and running but the user does not have the right license 3 5 4 ValidateNationalld 3 5 4 1 ValidateNationalld service performs the following functions e Checks that a national code from a specific country exists in the BICPlusIBAN Directory e Returns a validation message 3 5 4 2 Parameter Format for ValidateNationalld ReturnMessage validateNationalld String arg0 String arg1 Where Input Parameters Parameter Description Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification Webservices_v2_2 1 docx Page 17 argO lt country gt is the Country Code for which the national code has to be validated arg1 nationalid gt is the National Code to be validated Return Message Return Message Description Object Object Name Nationalld Attributes e result e countryCode e uniqueNationalld lt nationalld gt lt resulb lt resulb lt countryCode gt lt countryCode lt uniqueNationalld gt lt uniqueNationalld gt lt nationalld gt The attribute
28. ich the national code has to be validated corresponds to field COUNTRY CODE in BICPlusIBAN argi nationalid gt is the National Code to be validated corresponds to field UNIQUE NATIONAL ID in BICPlusIBAN Return Message Return Message Description Object Object Name NationalldDetails Attributes e result Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification Webservices_v2_2 1 docx Page 24 e countryCode e uniqueNationalld e specialCode e _institutionName e cityHeading e branchinformation e bicCode e branchCode e chipsUid e physicalAddress1 e physicalAddress2 e physicalAddress3 e physicalAddress4 e zipCode e location e countryName lt nationalldDetails lt resulb lt resulb lt countryCode gt lt countryCode lt uniqueNationalld gt lt uniqueNationalld gt specialCode gt lt specialCode lt institutionName gt lt institutionName gt lt branchInformation gt lt branchInformation lt cityHeading gt lt cityHeading lt bicCode gt bicCode lt branchCode lt branchCode lt chipsUid gt lt chipsUid gt lt physicalAddress1 gt lt physicalAddress1 gt lt physicalAddress2 gt lt physicalAddress2 gt lt physicalAddress3 gt l
29. ing criteria e Country code e Check digits they are calculated based on the scheme defined in ISO IEC 7064 Modulo 97 10 IBAN NATIONAL ID contained in the IBAN IBAN total length Please note that an IBAN must be provided in its electronic format e print format CZ94 5500 0000 0010 1103 8930 e electronic format CZ945500000000101 1038930 e It will be up to the user to convert to the electronic format first i e remove blank spaces e Returns a validation message 3 5 5 2 Parameter Format for Validatelban ReturnMessage validatelban String arg0 Where Input Parameters Parameter Description argO lt ibam is the IBAN to be validated Note that IBANs have the same formats in a given country but the formats can be different from country to country These formats are defined in the IBAN Registry SWIFT is the ISO registrar The IS file of the BICPlusIBAN directory also provides a machine readable list of the IBAN formats Return Message Return Message Description Object Object Name Iban Attributes e result e iban lt ibam cresult lt result lt iban gt lt iban gt Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification_Webservices_v2_2 1 docx Page 19 di
30. ll getAddress Sparam Snamespace if PEAR isError Sret print lt br gt An error Sret gt getCode occurred lt br gt print Error Sret gt getMessage lt br gt n else echo lt br gt Funtion getAddress SOGEFRPP result is lt b gt print_r ret echo lt b gt gt lt body gt lt html gt 4 4 Writing a Web Service PERL Client This sample is written with the following version ACTIVEPERL 5 8 9 826 SOAP Lite 0 55 r1 4 4 1 WSDL The Directories Web Services WSDL Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification_Webservices_v2_2 1 docx Page 42 e BIC Directory Web Service http www swift com solutions messaging information products image_ doc bicdirectory ws dl e IBAN Directory Web Service http www swift com solutions messaging information products image doc ibandirectory w sdl But in the following example as the SOAP Lite WSDL version is not compatible with our WSDL the example uses the PROXY and the URI 4 4 1 1 Directories Web Services URI BIC Directory Web Service https ws swift com IBAN Directory Web Service https ws swift com 4 4 1 2 Directories Web Services PROXY BIC Directory Web Service https
31. lly added as branch code e Note that the unpublished BICs are not considered as valid e Returns a information message 3 5 7 2 Parameter Format for GetDetailsFromBic ReturnMessage getDetailsFromBic String arg0 Where Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification Webservices_v2_2 1 docx Page 22 Input Parameters Parameter Description argO lt bic gt is the BIC to be validated Return Message Return Message Description Object Object Name BiclbanDetails Attributes e result e bicCode e branchCode e _institutionName e branchlnformation e cityHeading e countryCode e nationalld e specialCode e chipsUid e physicalAddress1 e physicalAddress2 e physicalAddress3 e physicalAddress4 e zipCode e location e countryName XML lt biclbanDetails lt resulb lt resulb lt bicCode lt bicCode lt banchCode gt lt branchCode lt institutionName gt lt institutionName lt branchInformation gt lt branchInformation lt cityHeading gt lt cityHeading lt countryCode gt lt countryCode lt nationalld gt lt nationalld gt specialCode gt lt specialCode chipsUid gt lt chipsUid gt lt physicalAddress1 gt lt physicalAddress1 gt lt physicalAdd
32. lowing functions e Validates any supplied IBAN according to the following criteria e Validate first e Validate that e Derive from e if IBAN is correct the BIC is correct the given IBAN the BIC issued with this IBAN If the derived BIC is the same as BIC argument provided If a 8 character BIC is provided then XXX is automatically added as BRANCH CODE then the returned message is VALID e f the derived BIC is not the same as BIC argument provided then validate the IBAN BIC co mbination For how to validate the IBAN BIC combination see the BICPlusIBAN Directory Technical Specifications Please note that an IBAN must be provided in its electronic format Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification_Webservices_v2_2 1 docx Page 20 e print format CZ94 5500 0000 0010 1103 8930 e electronic format CZ945500000000101 1038930 e It will be up to the user to convert to the electronic format first i e remove blank spaces e Returns a validation message 3 5 6 2 Parameter Format for ValidatelbanBic ReturnMessage validatelbanBic String argO String arg1 Where Input Parameters Parameter Description argO lt ibam is the IBAN to be validated Note that IBANs have the same formats in a given country b
33. nen tninn nno E R RORE R EATE 41 AAD PERL Coden pinnana nnna aa a jae 42 4 5 Writing a Web Service NET Client sseeeseesseeseeeesenssrresrnesrnssrnssrrssrnssrnssrnssrns 43 Al HITPS Prove el vais sco ce cesendion a Aa 43 452 gt Code Client with NED sic iccscescdsiies sadeukuae ansieunedehasae mesencsen 43 WEN COD E Re sana Cee E E il econe coedeeda iconic 43 Revision NOCOMG eo ccce sceccccreesctceete cece ce ccaetede scan cccvencc seen A Ena AA REDNA E a 45 Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification_Webservices_v2_2 1 docx Page 5 1 Purpose These technical specifications provide detailed information about the Directories Web Services It is intended for developers IT operations and architects 2 Preface 2 1 Purpose of this guide SWIFT has made a new set of web resources Web Services Technology available from SWIFT website These resources allow subscribers to the Directories Web Services service to use Web Services technologies to query the SWIFT Online Directories Data This document describes how to use this new service and how programmers can write code to invoke the service 2 2 Related publication To ensure correct use of the service it is mandatory that you read the user manual before u
34. om crdpws bicdirectory IBAN Directory Web Service https www2 swift com crdpws ibandirectory 4 3 3 PHP Code lt html gt lt head gt lt title gt PHP Web Services Directories BICDIRECTORY lt title gt lt head gt lt body gt Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification_Webservices_v2_2 1 docx Page 41 lt h2 gt PHP Web Services Directories BICDIRECTORY lt h2 gt lt php require once SOAP Client php SendPoint https www2 swift com crdpws bicdirectory Snamespace https ws swift com Sproxy array user gt YourUserName pass gt YourPassWord Ssoapclient new SOAP Client SendPoint false false Sproxy Ssoapclient gt setOpt curl CURLOPT SSL VERIFYPEER FALSE First call to enable the Basic Authentication challenge Ssoapclient gt call getStatus array S namespace ret Ssoapclient gt call getStatus array Snamespace printf lt br gt The BICDIRECTORY is lt b gt s lt b gt ret echo lt br gt lt br gt First call to enable the Basic Authentication challenge Ssoapclient gt call getStatus array Snamespace Sparam array arg0 gt SOGEFRPP ret Ssoapclient gt ca
35. on uses the pre emptive method for Basic Authentication the client application needs to simulate it self re active basic authentication to be compliant with the SWIFT security policy To simulate the re active basic authentication the BindingProvider SESSION_MAINTAIN_PROPERTY must be true and a first call to the WebService must be done to initiate the Basic Authenticatuion challenge author wioiris Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification_Webservices_v2_2 1 docx Page 38 public class BicWebServiceTest public static void main String args throws Exception r Instantiates the BicDirectoryWSService by passing the WSDL public url and QNAME String username your user name String password your password BicDirectoryWSService s new BicDirectoryWSService BicDirectoryWS bicDirectoryWS s getBicDirectoryWSPort addHttpBasicAuthentication bicDirectoryWS username password try r Initiates the authentication challenge by a first call This will throw automatically a ClientTransportException System out printIn bicDirectoryWS getStatus catch ClientTransportException ex r Eats the exception and checks if it is a real Unauthorized
36. rectory product INVALIDBIC The supplied BIC does not exist INVALIDCOMBINATION The supplied IBAN BIC combination is not valid INVALIDCOUNTRY The Country Code within the supplied IBAN does not exist example ZZ gt Is validated against the list of ISO country code CT file INVALIDIBANCOUNTRY The Country Code exists but is not registered in the IBAN Registry example ZW Is validated against the field IBAN COUNTRY CODE in the BICPlusIBAN Directory IS file gt Previous condition INVALIDCOUNTRY is checked first UNLISTEDCOUNTRY The Country Code is registered in the IBAN Registry but the national codes of this country are not listed in the BICPlusIBAN Directory ERRORCHECKDIGITS The IBAN failed the modulus check they are calculated based on the scheme defined in ISO IEC 7064 Modulo 97 10 INVALIDNATIONALID The country is listed but the supplied IBAN NATIONAL ID retrieved from the IBAN does not exist in the BICPlusIBAN Directory for this country it does not mean that the code does not exist in absolute ERRORIBANLENGTH The length of the supplied IBAN is not correct for this country 3 5 7 GetDetailsFromBic 3 5 7 1 GetDetailsFromBic service performs the following functions e Checks that the 11 character BIC exists in the BICPlusIBAN Directory and if yes it returns specific info for the supplied BIC e If an 8 character BIC is provided then XXX is automatica
37. ress2 gt lt physicalAddress2 gt lt physicalAddress3 gt lt physicalAddress3 gt lt physicalAddress4 gt lt physicalAddress4 lt zipCode gt lt zipCode Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification Webservices_v2_2 1 docx Page 23 lt dlocation gt lt location gt lt countryName gt lt countryName lt biclbanDetails gt The attribute result code meanings Result Code Description VALID The supplied BIC exists in the BICPlusIBAN Directory INVALID The supplied BIC does not exist in the BICPlusIBAN Directory INVALIDLICENSE You do not have enough privileges to execute this service To be allowed for this service you must have a valid subscription to the Directory product 3 5 8 GetDetailsFromNationalld 3 5 8 1 GetDetailsFromNationalld service performs the following functions e Checks that the NATIONAL ID exists in the BICPlusIBAN Directory and if yes it returns specific info for the supplied code e Returns a information message 3 5 8 2 Parameter Format for GetDetailsFromNationalld ReturnMessage getDetailsFromNationalld String arg0 String arg1 Where Input Parameters Parameter Description argO lt country is the Country Code for wh
38. result code meanings Result Code Description VALID The supplied NATIONAL ID exists in the BICPlusIBAN Directory for this country INVALID The country is listed but the supplied NATIONAL ID does not exist in the BICPlusIBAN Directory for this country it does not mean that the code does not exist in absolute INVALIDLICENSE You do not have enough privileges to execute this service To be allowed for this service you must have a valid subscription to the Directory product INVALIDCOUNTRY The Country Code of the Country Code supplied is not valid Example ZZ Must be validated against the list of ISO country code CT file UNLISTEDCOUNTRY The national codes of this country are not listed in the BICPlusIBAN Directory Example ZW e Indeed the directory does not include the national codes of all world countries so the system should first check if the country is valid or not INVALIDCOUNTRY and if valid then check if the country is a listed country of the directory Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification_Webservices_v2_2 1 docx Page 18 3 5 5 Validatelban 3 5 5 1 Validatelban service performs the following functions e Validates any supplied IBAN according to the follow
39. s confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification_Webservices_v2_2 1 docx Page 15 The attribute result code meanings Result Code Description VALID At least one added BIC has been found in the BIC Directory INVALID No result has been found INVALIDDATE The from date or to date is invalid INVALIDLICENSE You do not have enough privileges to execute this service To be allowed for this service you must have a valid subscription to the Directory product 3 5 Web Service for the BICPlusIBAN Directory All the queries access the Live SWIFT BICPlusIBAN Directory which is daily updated This assumes that the queries get always the latest SWIFT BICPlusIBAN Directory data 3 5 1 WSDL file The WSDL file is located in our SWIFT com public site http www swift com solutions messaging information products image doc ibandirectory wsdl 3 5 2 IbanDirectoryWSService version 1 0 Service Description GetStatus Returns the status of the Web Service ValidateNationalld Validates the National code from a National ID and a Country code and returns the validation result Validatelban Validates the IBAN from an IBAN and returns the validation result ValidatelbanBic Validates the combination of the IBAN and the BIC from an IBAN and a BIC and re
40. service To be allowed for this service you must have a valid subscription to the Directory product 3 4 6 GetListOfDeletedBic 3 4 6 1 GetListOfDeletedBic service performs the following functions e Checks if the period has been defined by a from date and a to date The from date is mandatory The to date is not mandatory e Returns the list of deleted BICs for the period defined by the from date and to date 3 4 6 2 Parameter Format for GetListOfDeletedBic ReturnMessage getListOfDeletedBic Date arg0 Date arg1 Where Input Parameters Parameter Description argO lt fromDate gt is the from date This parameter is mandatory arg1 lt toDate gt is the to date If this parameter is left empty null the to date will be the current date Return Message Return Message Description List of Object Object List BicDetailsList Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification_Webservices_v2_2 1 docx Page 12 Attributes e result e list List Of BicDetails Object Name BicDetails Attributes e result e bicCode e branchCode e institutionName branchinformation e cityHeading e countryCode e subType e val
41. sing the information contained in this guide The user manual provides valuable information about e Password policy e Subscription to the services e Account management 3 Interface Description 3 1 Overview The Directories Web Services service is available through a service accessible through HTTPS The service base URL is https www2 swift com crdpws The Directories Web Services service provides two Web Services e A Web Service for the BIC Directory This service mapped name is bicdirectory e A Web Service for the BICPlusIBAN Directory This service mapped name is ibandirectory 3 2 Authentication and Authorization The Directories Web Services service imposes the basic authentication method which mandates that client applications set the HTTPS header with a username and password pair for every request There is cookie returned to the requestor because there is application session maintained on the server See the RFC 2617 for a full description of Basic HTTP Authentication framework Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification Webservices_v2_2 1 docx Page 6 Specifically if HTTP client libraries other than Apache are selected particular attention must be paid to the way the HTTP challenge is m
42. t physicalAddress3 gt lt physicalAddress4 gt lt physicalAddress4 lt zipCode gt lt zipCode lt location gt lt location lt countryName gt lt countryName gt lt nationalldDetails gt XML The attribute result code meanings Result Code Description VALID The supplied NATIONAL ID exists in the BICPlusIBAN Directory for this country INVALID The country is listed but the supplied NATIONAL ID does not exist in the BICPlusIBAN Directory for this country it does not mean that the code does not exist in absolute Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification_Webservices_v2_2 1 docx Page 25 INVALIDLICENSE You do not have enough privileges to execute this service To be allowed for this service you must have a valid subscription to the Directory product INVALIDCOUNTRY The Country Code of the supplied Country Code argument is not valid Example ZZ gt __Is validated against the list of ISO country code CT file UNLISTEDCOUNTRY The national codes of this country are not listed in the BICPlusIBAN Directory Example ZW 3 5 9 GetDetailsFromChipsUid 3 5 9 1 GetDetailsFromChipsUid service performs the following functions e Checks tha
43. t it does not match to a BIC in the BICPlusIBAN Directory 3 5 13 GetConnectedBic 3 5 13 1 GetConnectedBic service performs the following functions e Checks that the 11 character BIC exists in the BICPlusIBAN Directory and if yes it returns the ROUTING BIC CODE for the supplied BIC1 e Checks that the proposed BIC is a BIC1 e Check if the BIC1 is present in the IBAN BIC CODE IBAN BRANCH CODE fields If yes then take the value of the ROUTING BIC CODE ROUTING BRANCH CODE if they exist e If an 8 character BIC is provided then XXX is automatically added as branch code e Note that the unpublished BICs are not considered as valid e Make a search on the field IBAN BIC CODE IBAN BRANCH CODE e Returns a information message 3 5 13 2 Parameter Format for GetConnectedBic ReturnMessage getConnectedBic String arg0 Where Input Parameters Parameter Description argO bic is the BIC to be checked Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification_Webservices_v2_2 1 docx Page 32 Return Message Return Message Description Object Object Name ConnectecBic Attributes e result e ibanBicCode e ibanBranchCode e routingBicCode e routingBranchCode lt connectedBic lt result res
44. t the NATIONAL ID exists in the BICPlusIBAN Directory and if yes it returns specific info for the supplied code e Returns a information message 3 5 9 2 Parameter Format for GetDetailsFromChipsUid ReturnMessage getDetailsFromChipsUid String arg0 Where Input Parameters Parameter Description argO lt chips gt is the CHIPS UID to be validated Return Message Return Message Description Object Object Name NationalldDetails Attributes e result e countryCode e uniqueNationalld e specialCode e institutionName e cityHeading e branchlnformation e bicCode e branchCode Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public InterfaceSpecification _Webservices_v2_2 1 docx Date 26 May 2010 Page 26 e chipsUid e physicalAddress1 e physicalAddress2 e physicalAddress3 e physicalAddress4 e zipCode e location e countryName XML nationalldDetails gt resulb lt resulb lt countryCode countryCode lt uniqueNationalld gt lt uniqueNationalld gt lt specialCode gt lt specialCode lt institutionName gt lt institutionName lt branchInformation gt lt branchInformation lt cityHeading gt lt cityHeading lt bicCode gt bicCode lt branchCode gt lt branchCode lt
45. turns the validation result GetDetailsFromBic Gets details about a specific institution from a BIC and returns the information result GetDetailsFromNationalld Gets details about a specific institution from a National ID anda Country code and returns the information result Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification_Webservices_v2_2 1 docx Page 16 GetDetailsFromChipsUid Gets details about a specific institution from a Chips UID and returns the information result DeriveBicFromlban Looks up the BIC issued with the IBAN from an IBAN and returns the information result LinkBic Provides the National ID linked to the BIC from a BIC and returns the information result LinkNationalld Provides the BIC linked to the National ID and the Country code from a Country code and a National ID and returns the information result GetConnectedBic Looks up the BIC connected to SWIFT for the non connected BIC from a BIC and returns the information result 3 5 3 GetStatus 3 5 3 1 GetStatus service performs the following functions e Verifies if the BICPlusIBAN Directory Web Service is running e Returns a status message 3 5 3 2 Parameter Format for GetStatus ReturnMessage
46. ueAddedServices e extralnformation e physicalAddress1 e physicalAddress2 e physicalAddress3 e physicalAddress4 e location e countryName lt bicDetailsList gt lt resulb lt result gt lt list gt lt bicDetails lt result gt lt result gt lt bicCode gt lt bicCode lt branchCode gt lt branchCode lt InstitutionName gt lt institutionName lt branchInformation gt lt branchInformation gt lt cityHeading gt lt cityHeading gt lt countryCode gt lt countryCode lt subT ype gt lt subT ype valueAddedServices gt lt valueAddedServices gt lt extralnformation gt lt extralnformation lt physicalAddress1 gt lt physicalAddress1 gt lt physicalAddress2 gt lt physicalAddress2 gt lt physicalAddress3 gt lt physicalAddress3 gt lt physicalAddress4 gt lt physicalAddress4 gt lt location gt lt location gt lt countryName gt lt countryName gt lt bicDetails lt bicDetails gt lt bicDetails gt lt bicDetails gt lt bicDetails gt lt bicDetails gt lt bicDetails gt XML Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification_Webservices_v2_2 1 docx Page 13 lt list gt lt bicDetailsList gt The attribute result code
47. ult lt ibanBicCode gt lt ibanBicCode lt ibanBranchCode gt lt ibanBranchCode lt routingBicCode gt lt routingBicCode lt routingBranchCode gt lt routingBranchCode lt connectedBic XML The attribute result code meanings Result Code Description VALID BIC1 is valid and a ROUTING BIC CODE is found INVALIDLICENSE You do not have enough privileges to execute this service To be allowed for this service you must have a valid subscription to the Directory product NOMATCHING The supplied BIC1 exists but it does not find a ROUTING BIC CODE in the BICPlusIBAN Directory INVALIDBIC The supplied BIC does not exist INVALIDBIC1 The supplied BIC exists but is not a BIC1 4 Cook Book 4 1 Introduction In this cook book section we provided samples only for set of the most popular languages and implementations But it does not mean that the Directories Web Services are not supported by other language or other implementation Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification_Webservices_v2_2 1 docx Page 33 Here worked examples showing how to access Directories Web Services from JAVA language JAX WS and AXIS2 PERL language Active Perl with SOAP Lite package P
48. ut the formats can be different from country to country These formats are defined in the IBAN Registry SWIFT is the ISO registrar The IS file of the BICPlusIBAN directory also provides a machine readable list of the IBAN formats argi bic is the BIC to be validated Return Message Return Message Description Object Object Name lbanBic Attributes result iban e ibanBicCode e ibanBranchCode lt ibanBic lt result lt result lt iban gt lt iban gt lt ibanBicCode gt lt ibanBicCode gt lt ibanBranchCode gt lt ibanBranchCode dibanBic gt The attribute result code meanings Result Code Description Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT InterfaceSpecification_Webservices_v2_2 1 docx Confidentiality Public Date 26 May 2010 Page 21 VALID IBAN is valid Note that we do not check the account number and the returned message will provide the BIC in its answer VALIDOTHER IBAN is valid Note that we do not check the account number and the returned message will provide the BIC of the user and the BIC of the BICPlusIBAN Directory in its answer INVALIDLICENSE You do not have enough privileges to execute this service To be allowed for this service you must have a valid subscription to the Di
49. ute result code meanings Result Code Description VALID IBAN is valid Note that we do not check the account number and the returned message will provide the BIC in its answer INVALIDLICENSE You do not have enough privileges to execute this service To be allowed for this service you must have a valid subscription to the Directory product INVALIDCOUNTRY The Country Code within the supplied IBAN does not exist example ZZ gt Is validated against the list of ISO country code CT file INVALIDIBANCOUNTRY The Country Code exists but is not registered in the IBAN Registry example ZW Is validated against the field IBAN COUNTRY CODE in the BICPlusIBAN Directory IS file gt Previous condition INVALIDCOUNTRY is checked first UNLISTEDCOUNTRY The Country Code is registered in the IBAN Registry but the national codes of this country are not listed in the BICPlusIBAN Directory ERRORCHECKDIGITS The IBAN failed the modulus check they are calculated based on the scheme defined in ISO IEC 7064 Modulo 97 10 INVALIDNATIONALID The country is listed but the supplied IBAN NATIONAL ID retrieved from the IBAN does not exist in the BICPlusIBAN Directory for this country it does not mean that the code does not exist in absolute ERRORIBANLENGTH The length of the supplied IBAN is not correct for this country 3 5 11 LinkBic 3 5 11 1 LinkBic service performs the following functions e Ch
50. vice Description GetStatus Returns the status of the Web Service ValidateBic Validates the BIC from a BIC Directory and message validation context and returns the validation result GetAddress Gets the address about a specific institution from a BIC and returns the information result GetListOfDeletedBic Gets the list of deleted BICs for a period defined by a from date and a to date GetListOfAddedBic Gets the list of added BICs for a period defined by a from date Copyright S W I F T SCRL 2010 All rights reserved The information herein is confidential and the recipient will not disclose it to third parties without the written permission of SWIFT Confidentiality Public Date 26 May 2010 InterfaceSpecification Webservices_v2_2 1 docx Page 8 and a to date 3 4 3 GetStatus 3 4 3 1 GetStatus service performs the following functions e Verifies if the BIC Directory Web Service is running e Returns a status message 3 4 3 2 Parameter Format for GetStatus ReturnMessage getStatus Where ReturnMessage is a String RUNNING the Web Service is up and running ERROR the Web Service is up and running but cannot access the Database INVALIDLICENSE the Web Service is up and running but the user does not have the right license 3 4 4 ValidateBic 3 4 4 1 ValidateBic service performs the following functions e Validates 11 character BICs e
51. yWSService CookieContainer cookieContainer ibanDirectoryWSService Credentials networkCredential Check if IbanDirectory Web Service is running string ibanDirectoryStatus ibanDirectoryWSService getStatus Response Write string Format IbanDirectoryWSService Status 0 lt br gt ibanDirectoryStatus Response Write lt br gt if ibanDirectoryStatus Equals running nationalIdDetails nationalIdDtls null Example of getDetailsFromNationallId nationalIdDtls ibanDirectoryWSService getDetailsFromNationalId BE 000 if nationalIdDtls null amp amp nationalIdDtls result Equals VALID Response Write string Format BIC 0 lt br gt nationalIdDtls bicCode 7 sponse Write string Format Branch Code 0 lt br gt nationalIdDtls branchCode Hj sponse Write string Format City Heading 0 lt br gt nationalIdDtls cityHeading pal sponse Write string Format Institution Name 0 lt br gt nationallIdDtls institutionName Response Write lt br gt Example of getDetailsFromNationalld nationalIdDtls ibanDirectoryWSService getDetailsFromNationalId RU 44583892 if nationalIdDtls null amp amp nationalIdDtls result Equals VALID Response Write string Format BIC 0 lt br gt nationalIdDtls bicCode Response Write

Directories Web Services

Contents

Download Pdf Manuals

Related Search

Related Contents