BIC / SWIFT API Overovanie Kódu

Ako integrovať BIC API Overovanie vo vašom softvéri

1. Čo je to BIC API Overovanie?

Pri spracovaní platieb a pri riešení transakcií súvisiacich s IBAN je pre úspešné platby nevyhnutné poskytnúť správny kód SWIFT / BIC.
Naša spoločnosť má licenciu na oficiálny adresár BIC od spoločnosti S.W.I.F.T SCRL, aby poskytla výkonný a jednoduchý spôsob automatického overenia BIC. Táto služba vám umožňuje integrovať vyhľadávanie v adresári kódu BIC vo vašom softvéri na interné účely

BIC API Overovanie má SWIFTRef dáta vo vnútri. BIC údaje použité s povolením S.W.I.F.T. SCRL. Vyhradené databázové práva 2019

2. Vlastnosti

Kľúčové vlastnosti BIC API overovania:

  • Načítať informácie o banke na základe BIC
  • Vyhľadajte v adresári BIC časť názvu banky a krajinu.
  • Vyhľadajte v adresári BIC historické záznamy.
  • Použite kompletnú a zjednodušenú odpoveď API pre ľahšiu integráciu.


3. Využitie API

BIC API Overovanie je založená na REST a podporuje jednoduché HTTP GET alebo POST požiadavky.

Akceptovateľné parametre sú uvedené v nasledujúcej tabuľke:

Názov poľa Dĺžka Typ Popis
bic 11 String BIC / SWIFT kód na vyhľadávanie. Môže mať 8 alebo 11 znakov
bank_name 256 String Časť názvu banky na vyhľadávanie v adresári BIC.
country 2 String Dvojmiestny kód krajiny. Vyžaduje sa pri vyhľadávaní podľa názvu banky.
api_key 128 String Váš osobný kľúč API.
format 4 String Vyžaduje sa špecifikácia formátu vrátených údajov. Aktuálne podporované hodnoty: json, xml
limit Integer Voliteľné: môžete použiť na obmedzenie počtu výsledkov pri vyhľadávaní podľa názvu banky.
hist integer Voliteľné: je možné použiť na zobrazenie historických záznamov z databázy pre vyhľadávanie v banke a BIC.
Vo vašom online portáli môžete nájsť kľúč API a požadovať URL koncového bodu, ktorý sa používa na zabezpečenie žiadostí o vyhľadávanie.


4. API XML Štruktúra Odpovedí

Môžete si stiahnuť XSD Schému API odpovede.
Podrobný opis vrátených polí nájdete v nasledujúcej tabuľke:

Názov Poľa Typ Dĺžka Vždy prítomné Popis
MODIFICATION FLAG Alphabetic 1 Áno V súboroch delta:
• A (prídavok)
• M (modifikácia)
• D (vymazanie) v plných súboroch V plných súboroch:
• A (prídavok)
CHANGED FIELD Numeric 186 Nie Zaznamená pole (alebo TAG), ktoré sa zmenilo buď v dôsledku zmeny záznamu, alebo ako výsledok novej udalosti.
 Jeden alebo viac stĺpcov je označený ako poradie čísel s každým číslom reprezentujúcim stĺpec zmenený z predchádzajúcej inštancie záznamu alebo predchádzajúcej udalosti.
Príklad "6,7,8,9"
Toto znamená že TYP UDALOSTI, DÁTUM UDALOSTI, BIC8, a BIC pobočky sa
zmenili.
Nasledujúce POLIA sú vylúčené zo zaznamenávania v ZMENENOM POLI:
• ZÁZNAMOVÝ KĽÚC
• ZMENENÉ POLE
• ZNAČKA MODIFIKÁCIE
RECORD KEY Alphanumeric 12 Áno Unikátny kľúč záznamu v súbore
 Každý záznam predstavuje udalosť v životnom cykle BIC
 Po priradení sa KĽÚČ ZÁZNAMU nikdy nezmení.
PREVIOUS RECORD KEY Alphanumeric 12 Nie KĽÚČ ZÁZNAMU predtým prepojenej UDALOSTI
  Všetky súvisiace udalosti sú prepojené a môžu byť umiestnené pomocou týchto informácií.
NEXT RECORD KEY Alphanumeric 12 Nie KĽÚČ ZÁZNAMU ďalšej súvisiacej prepojenej udalosti
  Všetky súvisiace udalosti sú prepojené a môžu byť umiestnené pomocou týchto informácií
EVENT TYPE Alphabetic 32 Áno UDALOSŤ alebo zmena popisu súvisiaceho s BIC, ku ktorému došlo v minulosti, v súčasnosti alebo sa vyskytne v budúcnosti.
Typy udalostí:
  • BIC VYDANÉ
  • BIC EXPIROVANÉ
  • BIC AKTIVOVANÉ NA FIN   • BIC AKTIVOVANÝ NA FA
  • BIC AKTIVOVANÝ NA IA
  • BIC deaktivovaný na FIN   • BIC deaktivovaný na FA
  • BIC deaktivovaný na IA   • BIC DEAKTIVOVANÝ
  • BIC SPOZASTAVENÝ
  • BIC REAKTIVOVANÝ
  • BIC ZVEREJNENÝ
  • BIC OFICIÁLNE MENO SA ZMENILO
  • NÁZOV BIC INŠTITÚCIE SA ZMENIL
  • BIC ADRESA ZMENENÁ
  • FIN SERVISNÝ KÓD ZMENENÝ
  Posledný dátum aktualizácie je posledný riadok sekvencie BIC (najnovší záznam)
  Keď sa pridá nová udalosť, ZNAĆKA MODIFIKÁCIE a ZMENA
  Stĺpec POLE bude aktualizovaný v bezprostredne predchádzajúcom súvisiacej UDALOSTI.
EVENT DATE Alphanumeric 8 Áno Dátum UDALOSTI
BIC8 Alphanumeric 8 Áno BIC (inštitúcia, krajina a prípona strany), kde:
  • Predpona strany (4 znaky)
  • Kód krajiny (2 znaky)
  • Prípona strany (2 znaky)
BRANCH BIC Alphanumeric 3 Áno Identifikátor pobočky BIC spojený s 8-znakovým BIC. Ak neexistuje žiadny identifikátor pobočky, použije sa XXX.
BIC Alphanumeric 11 Áno Úplný BIC: 8-znakový BIC a identifikátor pobočky
RECORD STATUS Alphabetic 1 Áno Označuje stav záznamu:
  • [C] = prúd reprezentujúci najnovšiu udalosť v reťazci až do dátumu uverejnenia, okrem [F] budúcich udalostí
  • [H] = Historické záznamy v reťazci udalostí
  • [F] = Budúca udalosť, ktorá nastane po dátume publikácie adresára. Predtým označená udalosť [C] bude platná až do dátumu určeného v búdúcej udalosti [F]
  V prípade udalostí v BUDÚCNOSTI dátum označuje, kedy bude zmena PLATNÁ.
OPERATIONALLY ACTIVE RECORD Alpha 1 Áno Existuje niekoľko záznamov pre rovnaké BIC. Toto pole označuje, ktoré záznamy pre ten istý BIC sú prevádzkovo aktívne BIC a mali by sa použiť   • [Y] Operatívne aktívny
  • [N] Operatívne neaktívny
  Pre každý jedinečný BIC existuje jeden záznam označujúci stav aktívny (Y)
  Záznamy s hist. Stavom [H] budú vždy označené [N]
  Záznamy s [C] urrent môže indikovať [Y] alebo [N]
  Záznamy s [F] budú vždy znamenať [N].
SUBTYPE INDICATOR Any type 4 Áno Typ podnikania subjektu. Indikátor podtypu sa poskytuje iba pre záznamy s BIC.
SWIFT FIN Alphabetic 1 Áno Stav pripojenia entity k FIN:
  • [Y] pripojený na FIN
  • [N] nie je pripojený k FIN
SWIFT FA Alphabetic 1 Áno Stav dostupnosti subjektu prostredníctvom FileAct:
  • [Y] pripojený k súboru FileAct
  • [N] nie je pripojený k súboru FileAct
SWIFT IA Alpha 1 Áno Stav dostupnosti subjektu prostredníctvom nástroja InterAct:
  • [Y] je pripojený k službe InterAct
  • [N] nie je pripojený k službe InterAct
LEGAL NAME Any 105 Nie Právny názov inštitúcie
INSTITUTION NAME Any 105 Áno Názov inštitúcie (uverejnený názov)
INSTITUTION TYPE Alphabetic 12 Áno Organizácia, ktorá sa zaoberá najmä finančným sprostredkovaním a / alebo pomocnými finančnými činnosťami
  Typ inštitúcie:
  • FINANČNÉ INFORMÁCIE
  • NEFINANČNÉ
ENTITY TYPE Alphabetic 16 Áno Identifikuje typ finančného subjektu:
  • Právnická osoba
  • Pobočka
  • Prevádzkové
RE STREET ADDRESS 1 Any 35 Nie [Registrácia] Názov ulice
RE STREET ADDRESS 2 Any 35 Nie [Registrácia] Názov ulice
RE STREET ADDRESS 3 Any 35 Nie [Registrácia] Budova, názov budovy, poschodie
RE STREET ADDRESS 4 Any 35 Nie [Registrácia] Oblasť
RE CITY Any 35 Nie [Registrácia] Názov mesta inštitúcie / pobočky
RE CPS Any 90 Nie [Registrácia] Kraj, provincia, štát alebo iný správny región vlastníka inštitúcie / pobočky
RE ZIP CODE Any 15 Nie [Registrácia] PSČ inštitúcie / pobočky
RE POB NUMBER Any 35 Nie Pole oddelené čiarkou s číslom POB inštitúcie / pobočky a súvisiacim poštovým smerovým číslom.
Príklad
"POB 103352, 40024"
To umožňuje zákazníkom používať úplnú adresu POB:
POB 103352
40024, DUESSELDORF (MESTO)
OP STREET ADDRESS 1 Any 35 Nie [Operatívne] Názov ulice
OP STREET ADDRESS 2 Any 35 Nie [Operatívne] Číslo ulice
OP STREET ADDRESS 3 Any 35 Nie [Operatívne]Budova, názov budovy, poschodie
OP STREET ADDRESS 4 Any 35 Nie [Operatívne] Oblasť
OP CITY Any 35 Nie [Operatívne] Názov mesta inštitúcie / pobočky
OP CPS Any 90 Nie [Operatívne] Kraj, provincia, štát alebo iný správny región vlastníka inštitúcie / pobočky
OP ZIP CODE Any 15 Nie [Operatívne] PSČ inštitúcie / pobočky
OP POB NUMBER Any 35 Nie Pole oddelené čiarkou s číslom POB inštitúcie / pobočky a súvisiacim poštovým smerovým číslom.
Príklad
"POB 103352, 40024"
To umožňuje zákazníkom používať úplnú adresu POB:<
POB 103352
40024, DUESSELDORF (MESTO)
BR STREET ADDRESS 1 Any 35 Nie [Pobočka] Názov ulice
BR STREET ADDRESS 2 Any 35 Nie [Pobočka] Číslo ulice
BR STREET ADDRESS 3 Any 35 Nie [Pobočka] Budova, názov budovy, poschodie
BR STREET ADDRESS 4 Any 35 Nie [Pobočka] Oblasť
BR CITY Any 35 Nie [Pobočka] Názov mesta inštitúcie / pobočky
BR CPS Any 90 Nie [Pobočka] Kraj, provincia, štát alebo iný správny región vlastníka inštitúcie / pobočky
BR ZIP CODE Any 15 Nie [Pobočka] PSČ inštitúcie / pobočky
BR POB NUMBER Any 35 Nie Pole oddelené čiarkou s číslom POB inštitúcie / pobočky a súvisiacim poštovým smerovým číslom..
Príklad
"POB 103352, 40024"
To umožňuje zákazníkom používať úplnú adresu POB:
POB 103352
40024, DUESSELDORF (MESTO)
BRANCH INFORMATION Any 70 Nie Branch information
Toto je bezplatný textový opis pobočky, ktorú poskytuje finančná inštitúcia, do ktorej patrí. V súčasnosti sa to bude poskytovať len pre položky s BIC a len vtedy, keď chce príslušná finančná inštitúcia poskytnúť tieto dodatočné informácie. Informácie sú získané z adresára BIC.
COUNTRY NAME Any 70 Áno Názov krajiny inštitúcie / pobočky, ako je uvedené v norme ISO 3166
ISO COUNTRY CODE Alphabetic 2 Áno Kód ISO 3166-1 alfa-2 krajiny inštitúcie / pobočky
LOCATION CODE Any type 1 Áno Obsahuje miesto (formálne v pozícii 7 normy BIC: 2009)
  Príklady:
  • Vo FR, BIC v Paríži = P
  • V BE, BIC v Bruseli = B
  • V USA sú BIC vo východnej cene = 3
FIN SERVICE CODES Any type 60 Nie FIN servisné kódy (nazývané aj servisné kódy s pridanou hodnotou). Kódy služby sú poskytované iba pre záznamy obsahujúce BIC
  Pole môže obsahovať až 20 trojmiestnych kódov v abecednom poradí.
RECORD KEY BDP Alphanumeric 12 Nie Jedinečný kľúč záznamu Bank Directory Plus v súbore.
FIELD A Any 1 Nie Vyhradené pre budúce použitie
FIELD B Any 64 Nie Vyhradené pre budúce použitie
FIELD C Any 128 Nie Vyhradené pre budúce použitie
FIELD D Any 256 Nie Vyhradené pre budúce použitie
FIELD E Any 11 Nie Vyhradené pre budúce použitie
FIELD F Any 12 Nie Vyhradené pre budúce použitie
Systém API vracia výsledky vo formáte XML, ktorý je ľahko analyzovaný v rôznych programovacích jazykoch a platformách.

Vzorová odpoveď XML z rozhrania API pre vyhľadávanie BIC by bola:


<result>
<bicdata>
<row>
<modification_flag>A</modification_flag>
<changed_field>34</changed_field>
<record_key>BP0000004OQQ</record_key>
<previous_record_key>BP00000030XZ</previous_record_key>
<next_record_key/>
<event_type>BIC ADRESA ZMENENÁ</event_type>
<event_date>20150606</event_date>
<bic8>BARCGB22</bic8>
<branch_bic>XXX</branch_bic>
<bic>BARCGB22XXX</bic>
<record_status>C</record_status>
<operationally_active_record>Y</operationally_active_record>
<subtype_indicator>SUPE</subtype_indicator>
<swift_fin>Y</swift_fin>
<swift_fa>N</swift_fa>
<swift_ia>N</swift_ia>
<legal_name>BARCLAYS BANK PLC</legal_name>
<institution_name>BARCLAYS BANK PLC</institution_name>
<institution_type>FINANČNÁ</institution_type>
<entity_type>Legal Entity</entity_type>
<re_street_address_1>1, CHURCHILL PLACE</re_street_address_1>
<re_street_address_2/>
<re_street_address_3/>
<re_street_address_4/>
<re_city>LONDÝN</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>LONDÝN</op_city>
<op_cps>LONDÝN E14 5HP</op_cps>
<op_zip_code/>
<op_pob_number/>
<br_street_address_1/>
<br_street_address_2/>
<br_street_address_3/>
<br_street_address_4/>
<br_city/>
<br_cps/>
<br_zip_code/>
<br_pob_number/>
<branch_information>(ALL U.K. OFFICES)</branch_information>
<country_name>SPOJENÉ KRÁĽOVSTVO</country_name>
<iso_country_code>GB</iso_country_code>
<location_code>2</location_code>
<fin_service_codes>EBAERPFINSCOSTGTGT</fin_service_codes>
<record_key_bdp>BD00000006FO</record_key_bdp>
<field_a/>
<field_b/>
<field_c/>
<field_d/>
<field_e/>
<field_f></field_f>
</row>
</bicdata>
<errors/>
</result>




5. API Chyby

V prípade chyby API vracia odpoveď XML obsahujúcu chybové hlásenie.

Znaky XML sa vrátia bez akýchkoľvek iných polí v odpovedi XML.

Nižšie nájdete popis všetkých možných chybových hlásení, ktoré je možné vrátiť:

Stav kódu Typ Popis
301 Account Error API Kľúč je neplatný
302 Account Error Predplatné vypršalo
303 Account Error Žiadne dostupné dotazy
304 Account Error Nemáte žiadny prístup k tomuto API
401 Input Error Prijatá SWIFT dĺžka je 8 alebo 11 znakov
402 Input Error Názov banky je neplatný! Bankové vyhľadávanie by malo mať minimálne 4 znaky.
Povolené znaky a-z, A-Z, 0-9, [medzera]!
403 Input Error Kód krajiny je nesprávny! Povolený je 2-miestny kód krajiny. Príklad: UK, DE, FR