BIC/SWIFT-koodi valideerimise API

BIC Validation API integreerimine tarkvarasse

1. Mis on BIC-koodi valideerimise API?

Traadimaksete töötlemisel ja IBANiga seotud tehingutega tegelemisel on õige SWIFT/BIC-koodi sisestamine maksete sooritamise puhul ülioluline.
Meie ettevõte on litsentsinud ametliku BIC-kataloogi S.W.I.F.T SCRL-ist, et pakkuda võimsat ja lihtsat viisi BIC-koodide automaatseks valideerimiseks. See teenus võimaldab teil integreerida BIC-koodikataloogi otsingu oma tarkvarasse

BIC Validation API-l on SWIFTRef Data Inside. S.W.I.F.T. SCRL loal kasutatud BIC-andmed. Andmebaasiõigused on reserveeritud

2. Funktsioonid

BIC-koodide valideerimise API võtmefunktsioonid:

  • Saate BIC-l abil panga kohta teavet otsida.
  • Otsige BIC-kataloogist panga nimi ja riik.
  • Otsige BIC-kataloogist ajaloolisi kirjeid.
  • Hõlpsamaks integreerimiseks saate kasutada nii täielikku kui ka lihtsustatud API-vastust.


3. API kasutus

BIC Validation API on REST-põhine ja toetab lihtsaid HTTP GET - või POST-taotlusi.

Aktsepteeritud parameetrid on toodud alljärgnevas tabelis:

Välja nimi Pikkus Tüüp Kirjeldus
bic 11 Rida BIC/SWIFT-koodi otsimiseks. Võib olla 8 või 11 märki
bank_name 256 Rida Osa panga nimest, mida BIC-kataloogist otsida.
country 2 Rida Kahe tähega riigikood. Nõutud panga nime järgi otsimisel.
api_key 128 Rida Teie isiklik API võti.
format 4 Rida Nõutav tagastatud andmete vormingu määramiseks. Praegu toetatud väärtused: json, xml
limit Täisarv Valikuline: seda saab kasutada tulemite arvu piiramiseks panga nime järgi otsimisel.
hist Täisarv Valikuline: seda saab kasutada nii panga - kui ka BIC-otsingu jaoks andmebaasist pärinevate ajalooliste kirjete kuvamiseks.
Veebiportaalis leiate oma API võtme ja päringu lõpp-punkti URL-i, mida kasutatakse otsingutaotluste turvamiseks.


4. API XML-vastuse struktuur

Saate alla laadida API vastuse XSD-skeemi.
Tagastatud vaate väljade kirjeldust vt järgmisest tabelist:

Välja nimi Tüüp Pikkus Alati kohal Kirjeldus
MUUDETAV SILT Tähestik 1 Jah. Delta failides:
• A (lisa)
• M (modifikatsioon)
• D (kustutamine) täisfailides:
• A (lisa)
MUUDETUD VÄLI Arvuline 186 Ei ole Salvestab välja (või TAGI), mis on muutunud kas kirje muutmise või uue EVENTi tulemusena.
Üks või mitu veergu on tähistatud numbriseeriana, mille iga number tähistab eelmise kirjeeksemplari või eelmise EVENTi asemel muudetud veergu.
Näide „6,7, 8,9”
See tähendab, et EVENT TYPE, EVENT DATE, BIC8 ja BRANCH BIC on
muutunud.
Järgmisi VÄLJU ei registreerita MUUDETUD VÄLI:
• SALVESTUSVÕTI
• MUUDETUD VÄLI
• MUUDETAV SILT
KIRJEVALIK Tähtnumbriline 12 Jah. Kirje kordumatu võti failis
Iga kirje tähistab sündmust BIC-elutsüklis.
Pärast määramist ei muutu SALVESTUSVÕTI mitte kunagi.
EELMINE SALVESTUSVÕTI Tähtnumbriline 12 Ei ole Varem lingitud EVENTi SALVESTUSVÕTI
Kõik seotud sündmused on lingitud ja neid saab selle teabe abil leida.
JÄRGMINE SALVESTUSVÕTI Tähtnumbriline 12 Ei ole Järgmise seotud sündmuse SALVESTUSVÕTI Kõik seotud sündmused on lingitud ja neid saab selle teabe abil leida
SÜNDMUSE TÜÜP Tähestik 32 Jah. EVENT või muudatuse kirjeldus, mis on seotud BIC-ga, mis on toimunud minevikus, olevikus või toimub tulevikus.
Sündmuse tüübid:
• BIC ISSUED
• BIC EXPIRED
• BIC ACTIVATED ON FIN
• BIC ACTIVATED ON FA
• BIC ACTIVATED ON IA
• BIC DEACTIVATED ON FIN
• BIC DEACTIVATED ON FA
• BIC DEACTIVATED ON IA
• BIC DEACTIVATED • BIC SUSPENDED


BIC REACTIVATED •
BIC PUBLISHED
BIC LEGAL NAME CHANGED
• BIC ADDRESS CHANGED
• FIN SERVICE CODE CHANGED
Viimane uuendamise kuupäev on BICi tsükli viimane rida (st kõige viimane kanne).
Kui lisatakse uus EVENT, uuendatakse veergu MUUDETAV SILT ja MUUDETUD
VÄLI vahetult eelmises seotud EVENTis.
SÜNDMUSE KUUPÄEV Tähtnumbriline 8 Jah. SÜNDMUSE kuupäev
BIC8 Tähtnumbriline 8 Jah. BIC (asutus, riik ja osapoole järelliide), kus:
• osapoole eesliide (4 char)
• riigi kood (2 char)
• osapoole järelliide (2 char)
BRANCH BIC Tähtnumbriline 3 Jah. 8-märgilise BIC-ga seotud BICi-haru tunnus. Kui haru identifikaatorit pole olemas, kasutatakse funktsiooni XXX.
BIC Tähtnumbriline 11 Jah. Täielik BIC: 8-märgiline BICi ja filiaali tunnus
KIRJE OLEK Tähestik 1 Jah. Näitab kirje olekut: • [C] = Praegune, mis tähistab viimast sündmust ahelas kuni avaldamise kuupäevani, välja arvatud
[F] Tuleviku sündmused
• [H] = Ajaloolised kirjed aündmuste ahelas
• [F] = Tuleviku sündmus, mis toimub pärast kataloogi avaldamise kuupäeva. Varem näidatud [C] Praegune sündmus kehtib kuni [F] Tuleviku sündmuses määratud kuupäevani.
TULEVIKU sündmuste puhul näitab kuupäev, millal muutus on KEHTIV ALATES.
OPERATIIVSELT AKTIIVNE SALVESTUS Alfa 1 Jah. Sama BIC-i jaoks on mitu kirjet. See väli näitab, milline BICi kirjetest on operatiivselt aktiivne ja mida tuleks kasutada.
• [Y] Operatiivselt aktiivne
• [N] Operatiivselt mitteaktiivne
Iga unikaalse BICi kohta on üks kirje, mis näitab AKTIIVSET olekut (Y).
Ajaloolised kirjed, mille olek on [H], näitavad alati [N].
Kirjed, mille väärtus on [C], võivad viidata [Y] või [N].
Kirjed tähisega [F] tähistavad alati tähist [N].
ALATÜÜBI INDIKAATOR Suvaline tüüp 4 Jah. Majandusüksuse äritüüp. Alamtüübi indikaator on ette nähtud ainult koos BIC-ga olevate kirjete jaoks.
SWIFT FIN Tähestik 1 Jah. Üksuse FIN-ühenduse olek: • [Y] ühendatud FIN-iga
• [N] ei ole ühendatud FIN-iga
SWIFT FA Tähestik 1 Jah. Üksuse kättesaadavuse staatus FileAct'i kaudu: • [Y] ühendatud FileAct'ga
iga • [N] ei ole ühendatud FileAct'iga
SWIFT IA Alfa 1 Jah. Üksuse kättesaadavuse staatus Interact'i kaudu: • [Y] on seotud Interact'
iga • [N] ei ole seotud Interact'iga
JURIIDILINE NIMI Suvaline 105 Ei ole Asutuse juriidiline nimi
ASUTUSE NIMI Suvaline 105 Jah. Krediidiasutuse või investeerimisühingu kauplemisnimi (avaldatud nimi)
ASUTUSE TÜÜP Tähestik 12 Jah. Organisatsioon, mis tegeleb peamiselt finantsvahenduse ja/või finantsialase tegevusega
Institutsiooni liik:
• FINANTSIALANE
• MITTE FINANTSIALANE
OLEMI TÜÜP Tähestik 16 Jah. Määrab kindlaks finantsüksuse liigi: • juriidiline isik
• filiaal
• tegev
RE TÄNAVA AADRESS 1 Suvaline 35 Ei ole [registreeritud] Tänava nimi
RE TÄNAVA AADRESS 2 SUVALINE 35 Ei ole [registreeritud] Tänavanumber
RE TÄNAVA AADRESS 3 Suvaline 35 Ei ole [registreeritud] Ehitis, hoone nimi, korrus
RE TÄNAVA AADRESS 4 Suvaline 35 Ei ole [registreeritud] Piirkond
RE LINN Suvaline 35 Ei ole [registreeritud] Asutuse/filiaali linna nimi
RE HALDUSPIIRKOND Suvaline 90 Ei ole [registreeritud] Asutuse/filiaali maakond, osariik või muu halduspiirkond
RE ZIP KOOD Suvaline 15 Ei ole [registreeritud] Asutuse/filiaali sihtnumber
RE POB NUMBER Suvaline 35 Ei ole Komaeraldusega väli, millel on asutuse/filiaali POB-number ja sellega seotud ZIP-kood.
Näide
„POB 103352, 40024”
See võimaldab klientidel kasutada kogu POB aadressi:
POB 103352
40024, DUESSELDORF (LINN)
OP TÄNAVA AADRESS 1 SuVALINE 35 Ei ole [Filiaal] tänava nimi
OP TÄNAVA AADRESS 2 Suvaline 35 Ei ole [Filiaal] Tänavanumber
OP TÄNAVA AADRESS 3 Suvaline 35 Ei ole [Filiaal] Ehitis, hoone, korrus
OP TÄNAVA AADRESS 4 SUVALINE 35 Ei ole [Filiaal] Piirkond
OP LINN Suvaline 35 Ei ole [Filiaal] Asutuse/filiaali linna nimi
OP HALDUSPIIRKOND Mis tahes 90 Ei ole [Filiaal] Asutuse/filiaali maakond või muu halduspiirkond
OP ZIP-KOOD Suvaline 15 Ei ole [Filiaal] Asutuse/filiaali sihtnumber
OP POB NUMBER Suvaline 35 Ei ole Komaeraldusega väli, millel on asutuse/filiaali POB-number ja sellega seotud ZIP-kood.
Näide
„POB 103352, 40024”
See võimaldab klientidel kasutada kogu POB aadressi:
POB 103352
40024, DUESSELDORF (LINN)
BR TÄNAVA AADRESS 1 Suvaline 35 Ei ole [Filiaal] Tänava nimi
BR TÄNAVA AADRESS 2 Suvaline 35 Ei ole [Filiaal] Tänavanumber
BR TÄNAVA AADRESS 3 Suvaline 35 Ei ole [Filiaal] Ehitis, hoone, korrus
BR TÄNAVA AADRESS 4 Suvaline 35 Ei ole [Filiaal] piirkond
BR LINN Suvaline 35 Ei ole [Filiaal] Asutuse/filiaali linna nimi
BR HALDUSPIIRKOND Suvaline 90 Ei ole [Filiaal] Asutuse/filiaali maakond,osariik või muu halduspiirkond
BR ZIP-KOOD Suvaline 15 Ei ole [Filiaal] Asutuse/filiaali sihtnumber
BR POB NUMBER Suvaline 35 Ei ole Komaeraldusega väli, millel on asutuse/filiaali POB-number ja sellega seotud ZIP-kood.
Näide
„POB 103352, 40024”
See võimaldab klientidel kasutada kogu POB aadressi:
POB 103352
40024, DUESSELDORF (LINN)
FILIAALI TEAVE Suvaline 70 Ei ole Filiaali teave
See on filiaali kirjeldusvabas vormis, mille on esitanud finantsasutus, kellele ta kuulub. Praegu esitatakse see ainult BIC-ga kannete puhul ja ainult siis, kui finantsasutus soovib seda lisateavet esitada. Teave pärineb BIC-kataloogist.
RIIGI NIMI Suvaline 70 Jah. Asutuse/filiaali riiginimi vastavalt standardile ISO 3166
ISO RIIGIKOOD Tähestik 2 Jah. Asutuse/filiaali asukohariigi ISO 3166-1 alfa-2 kood
ASUKOHA TÄHIS Suvaline tüüp 1 Jah. Sisaldab asukohta (ametlikult BIC standardi 7. positsioonil: 2009) Näited
:
• FR, BIC Pariisis = P
• BE, BIC Brüsselis = B
• USAs, BIC Idarannikul = 3
FIN TEENUSEKOODID Suvaline tüüp 60 Ei ole FIN teenusekoodid. Teenusetähiseid pakutakse ainult BIC-tähist sisaldavate kirjete puhul.
Väli võib tähestikulises järjestuses sisaldada kuni 20 kolmetähelist tähist.
SALVESTUSVÕTME BDP Tähtnumbriline 12 Ei ole Bank Directory Plusi kirje kordumatu võti failis.
VÄLI A Suvaline 1 Ei ole Reserveeritud edaspidiseks kasutamiseks
VÄLI B Suvaline 64 Ei ole Reserveeritud edaspidiseks kasutamiseks
VÄLI C Suvaline 128 Ei ole Reserveeritud edaspidiseks kasutamiseks
VÄLI D Suvaline 256 Ei ole Reserveeritud edaspidiseks kasutamiseks
VÄLI E Suvaline 11 Ei ole Reserveeritud edaspidiseks kasutamiseks
VÄLI F Suvaline 12 Ei ole Reserveeritud edaspidiseks kasutamiseks
API süsteem tagastab tulemused XML-vormingus, mida on lihtne sõeluda mitmesugustes programmeerimiskeeltes ja platvormides.

API XML-vastus BIC-otsingule oleks järgmine:


<result>
 <bicdata>
 <row>
 A </modification_flag> <changed_field> 34 </changed_field>
 <record_key> <bic> BP0000004OQQ </record_key>
 <previous_record_key> <modification_flag>
 BP00000030XZ </previous_record_key>
 <next_record_key/>
 <event_type> <legal_name> BIC ADDRESS CHANGED </event_type>
 <event_date> 20150606 </event_date>
 <bic8> BARCGB22 <branch_bic> XXX </branch_bic>
 BARCGB22XXX <record_status> </bic>
 </record_status>
 <operationally_active_record> <br_street_address_4/>
 </operationally_active_record> <subtype_indicator> </subtype_indicator> <swift_fin> SUPE
 <swift_fa> </swift_fin> <swift_ia> N

 </swift_fa>
 BARCLAYS BANK PLC </swift_ia>
 BARCLAYS BANK PLC </legal_name>
 <institution_name> BARCLAYS BANK PLANK PLANK </institution_name>
 </bic8>
 <br_city/>
 <institution_type> <br_cps/>
 <br_zip_code/>
 </branch_information> </country_name> <iso_country_code> </iso_country_code>
 <location_code> </location_code>
 CHANK 1 <fin_service_codes> </fin_service_codes> <record_key_bdp> BD00000006FO </record_key_bdp>
 <field_a/>
 <field_b/>
 </entity_type> <field_c/>
 </institution_type>
 <field_d/>
 LONDON LONDON </re_street_address_1> LONDON LONDON <entity_type> LONDON ON
 <re_city> LONDON LONDON LONDON LONDON LONDON LONDON LONDON LONDON LONDON LONDON LONDON LONDON <re_street_address_4/>
 <re_street_address_2/>
 <re_street_address_1>
 LONDON LONDON LONDON LONDON LONDON LONDON LONDON LONDON LONDON LONDON <re_street_address_3/>
 LONDON ON </re_city>
 <re_cps/>
 <re_zip_code> E14 5HP </re_zip_code>
 <re_pob_number/>
 <op_street_address_1> 1 CHURCHILL PLACE </op_street_address_1>
 <op_street_address_2/>
 <op_street_address_3/>
 <op_street_address_4/>
 <op_city> LONDON </op_city>
 <op_cps> LONDON
 E14 5HP </op_cps>
 <op_zip_code/>
 <op_pob_number/>
 <br_street_address_1/>
 <br_street_address_2/>
 <br_street_address_3/>
 <branch_information>
 <br_pob_number/>
 <country_name>
 <field_e/>
 <field_f> </row>
 </bicdata>
 <errors/>
 </field_f>
 </result>




5. API tõrked

Tõrke korral tagastab API XML-vastuse, mis sisaldab tõrketeadet.

TheXml-sildid tagastatakse ilma XML-vastuse väljadeta.

Allpool leiate kõigi võimalike tõrketeadete kirjelduse:

Olekukood Tüüp Kirjeldus
301 Konto tõrge API võti on kehtetu
302 Konto tõrge Tellimus on aegunud
303 Konto tõrge Päringuid pole saadaval
304 Konto tõrge Teil pole sellele API-le juurdepääsu
401 Sisendi tõrge Aktsepteeritud SWIFTi pikkus 8 või 11 märki”
402 Sisendi tõrge Panga nimi on kehtetu! Pangaotsing peaks olema vähemalt 4 tähemärki.
Lubatud märgid a-z, A-Z, 0-9, [tühik]!
403 Sisendi tõrge Riigikood on vale! Lubatud on 2 tähega riigikood. Näide: UK, DE, FR