API za potrjevanje BIC / SWIFT kode

Kako integrirati API za potrjevanje BIC kode v programsko opremo

1. Kaj je API za potrjevanje BIC kode?

Pri obdelavi plačil preko žice in obravnavanju transakcij, povezanih z IBAN-om, je zagotavljanje pravilne SWIFT / BIC kode ključnega pomena za uspešno plačilo.
Naše podjetje je licenciralo uradni BIC seznam S.W.I.F.T SCRL, da bi zagotovili zmogljiv in preprost način samodejnega potrjevanje BIC kode. Ta storitev vam omogoča, da v svojo programsko opremo vključite iskanje po seznamih BIC kod za interne namene

API za potrjevanje veljavnosti BIC vsebuje podatke SWIFTRef. BIC podatki so uporabljeni z dovoljenjem S.W.I.F.T. SCRL. Vse pravice pridržane 2019

2. Značilnosti

Ključne značilnosti API-ja za potrjevanje BIC kode:

  • Pridobivanje informacij o banki na podlagi BIC kode.
  • Iskanje po BIC seznamih z delnim imenom banke ali države.
  • Iskanje zgodovinskih zapisov po BIC seznamih
  • Za lažjo integracijo uporabite popoln in poenostavljen API odziv.


3. Uporaba API-ja

API za BIC potrjevanje temelji na REST-u in podpira preproste HTTP GET ali POST zahteve.

Sprejeti parametri so navedeni v spodnji tabeli:

Naziv Dolžina Tip Opis
bic 11 String BIC / SWIFT koda za iskanje. Lahko ima 8 ali 11 znakov.
bank_name 256 String Del imena banke za iskanje po BIC seznamu.
country 2 String Dvečrkovna koda države. Potrebno pri iskanju po imenu banke.
api_key 128 String Vaš osebni API ključ.
format 4 String Potrebno je določiti format vrnjenih podatkov. Trenutno podprte vrednosti: json, xml
limit Integer Neobvezno: lahko se uporabi za omejitev števila rezultatov pri iskanju po imenu banke.
hist integer Neobvezno: lahko se uporabi za prikaz zgodovinskih zapisov iz baze podatkov pri iskanju po banki ali BIC kodi.
Znotraj vašega spletnega portala lahko najdete API ključ in zahtevo za Endpoint URL, ki se uporablja za zaščito iskanih zahtev.


4. API XML odzivna struktura

Tukaj si lahko prenesete XSD shemo za odziv API-ja.
Podroben opis vrnjenih polj je prikazan v spodnji tabeli:

Naziv polja Tip Dolžina Vedno prisotna Opis
MODIFICATION FLAG Abecedno 1 Da V delta podatkih:
• A (addition)
• M (modification)
• D (deletion) v polnih datotekah:
• A (addition)
CHANGED FIELD Številsko 186 Ne Zabeleži polje (ali TAG), ki se je spremenilo zaradi spremembe v zapisu ali kot rezultat novega dogodka (EVENT).
En ali več stolpcev je označenih kot zaporedje števil, pri čemer je vsaka številka, ki predstavlja stolpec, spremenjena od prejšnjega primerka zapisa ali prejšnjega dogodka (EVENT).
Primer "6,7,8,9"
To pomeni, da so se EVENT TYPE, EVENT DATE, BIC8, in BRANCH BIC
spremenili.
Naslednja polja (FIELDS) se ne bodo beležila v CHANGED FIELD:
• RECORD KEY
• CHANGED FIELD
• MODIFICATION FLAG
RECORD KEY Alfanumerično 12 Da Edinstven ključ zapisa v datoteki
Vsak zapis predstavlja dogodek v življenjskem ciklu BIC-a.
Ko je enkrat dodeljen, se RECORD KEY nikoli ne spremeni.
PREVIOUS RECORD KEY Alfanumerično 12 Ne RECORD KEY predhodno povezanega dogodka (EVENT)br> Vsi dogodki so povezani in se lahko najdejo z uporabo teh informacij
NEXT RECORD KEY Alfanumerično 12 Ne RECORD KEY naslednjega povezanega dogodka (EVENT)
Vsi dogodki so povezani in se lahko najdejo z uporabo teh informacij
EVENT TYPE Abecedno 32 Da Opis DOGODKA (EVENT) ali spremembe, povezane z BIC kodo, ki se je zgodil v preteklosti, v sedanjosti ali se bo zgodil v prihodnosti.
Vrste dogodka:
• 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 INSTITUTION NAME CHANGED
• BIC ADDRESS CHANGED
• FIN SERVICE CODE CHANGED
Zadnji datum posodobitve je zadnja vrstica zaporedja BIC kode (zadnji vnos).
Ko je dodan nov EVENT, se stolpci MODIFICATION FLAG in CHANGED
FIELD posodobijo v predhodnem, s tem povezanim dogodkom (EVENT).
EVENT DATE Alfanumerično 8 Da Datum DOGODKA (EVENT)
BIC8 Alfanumerično 8 Da BIC koda (institucija, država in lokacija):
• Koda banke (štirje znaki)
• Koda države (dva znaka)
• Lokacijska koda (dva znaka)
BRANCH BIC Alfanumerično 3 Da Identifikator podružnice, povezan z 8-znakovno BIC kodo. Če identifikator podružnice ne obstaja, se uporabi XXX.
BIC Alfanumerično 11 Da Polna BIC koda: 8-znakovna BIC koda in identifikator podružnice
RECORD STATUS Abecedno 1 Da Označuje stanje zapisa:
• [C] = (Current) Trenutno predstavlja zadnji dogodek v verigi do datuma objave, razen prihodnjih [F] dogodkov
• [H] = Zgodovinski zapisi v verigi dogodkov
• [F] = Prihodnji dogodek, ki se bo zgodil po datumu objave seznama. Prej naveden [C] trenutni dogodek bo veljaven do datuma, določenega v prihodnjem [F] dogodku.
Za PRIHODNJE dogodke, datum označuje, kdaj bo sprememba ZAČELA VELJATI
OPERATIONALLY ACTIVE RECORD Alfanumerično 1 Da Za isti BIC obstaja več zapisov. To polje označuje, kateri zapisi za isto BIC kodo so operativno aktivni in bi jih bilo treba uporabiti.
• [Y] Operativno aktivni
• [N] Operativno neaktivni
Za vsako unikatno BIC kodo obstaja en vnos zapisov, ki označuje aktivno (ACTIVE) stanje (Y).
Zapisi z [H] zgodovinskim stanjem bodo vedno prikazani z [N].
Trenutni zapisi [C] so lahko označeni z [Y] ali [N].
Zapisi z [F] bodo vedno označeni z [N].
SUBTYPE INDICATOR Kateri koli tip 4 Da Vrsta poslovanja subjekta. "Subtype Indicator" je na voljo samo za zapise z BIC.
SWIFT FIN Abecedno 1 Da Dosegljivosti subjekta prek FIN-a:
• [Y] priključen na FIN
• [N] ni priključen na FIN
SWIFT FA Abecedno 1 Da Dosegljivosti subjekta prek FileAct-a:
• [Y] priključen na FileAct
• [N] ni priključen na FileAct
SWIFT IA Alpha 1 Da Dosegljivosti subjekta prek InterAct-a:
• [Y] priključen na InterAct
• [N] ni priključen na InterAc
LEGAL NAME Kateri koli tip 105 Ne Pravno ime institucije
INSTITUTION NAME Kateri koli tip 105 Da Poslovno ime institucije (objavljeno ime)
INSTITUTION TYPE Abecedno 12 Da Organizacija, ki se v glavnem ukvarja s finančnim posredovanjem in / ali pomožnimi finančnimi dejavnostmi
Vrsta institucije:
• FINANČNA
• NEFINANČNA
ENTITY TYPE Abecedno 16 Da Označuje vrsto finančnega subjekta:
• Pravna oseba
• Podružnica
• Operativna
RE STREET ADDRESS 1 Kateri koli tip 35 Ne [Registracija] Ime ulice
RE STREET ADDRESS 2 Kateri koli tip 35 Ne [Registracija] Številka ulice
RE STREET ADDRESS 3 Kateri koli tip 35 Ne [Registracija] Stavba, ime stavbe, nadstropje
RE STREET ADDRESS 4 Kateri koli tip 35 Ne [Registracija] Območje
RE CITY Kateri koli tip 35 Ne [Registracija] Ime mesta institucije / podružnice
RE CPS Kateri koli tip 90 Ne [Registracija] Okrožje, pokrajina, država ali druga upravna regija lastniške ustanove / podružnice
RE ZIP CODE Kateri koli tip 15 Ne [Registracija] Poštna številka institucije / podružnice
RE POB NUMBER Kateri koli tip 35 Ne Polje, ločeno z vejico, ki vsebuje številko poštnega nabiralnika institucije / podružnice in z njo povezano poštno številko
Primer
"POB 103352, 40024"
To strankam omogoča uporabo celotnega naslova:
POB 103352
40024, DUESSELDORF (CITY)
OP STREET ADDRESS 1 Kateri koli tip 35 Ne [Operativna] Ime ulice
OP STREET ADDRESS 2 Kateri koli tip 35 Ne [Operativna] Številka ulice
OP STREET ADDRESS 3 Kateri koli tip 35 Ne [Operativna] Stavba, ime stavbe, nadstropje
OP STREET ADDRESS 4 Kateri koli tip 35 Ne [Operativna] Območje
OP CITY Kateri koli tip 35 Ne [Operativna] Ime mesta institucije / podružnice
OP CPS Kateri koli tip 90 Ne [Operativna] Okrožje, pokrajina, država ali druga upravna regija lastniške ustanove / podružnice
OP ZIP CODE Kateri koli tip 15 Ne [Operativna] Poštna številka institucije / podružnice
OP POB NUMBER Kateri koli tip 35 Ne Polje, ločeno z vejico, ki vsebuje številko poštnega nabiralnika institucije / podružnice in z njo povezano poštno številko.
Primer
"POB 103352, 40024"
To strankam omogoča uporabo celotnega naslova:
POB 103352
40024, DUESSELDORF (CITY)
BR STREET ADDRESS 1 Kateri koli tip 35 Ne [Podružnica] Ime ulice
BR STREET ADDRESS 2 Kateri koli tip 35 Ne [Podružnica] Številka ulice
BR STREET ADDRESS 3 Kateri koli tip 35 Ne [Podružnica] Stavba, ime stavbe, nadstropje
BR STREET ADDRESS 4 Kateri koli tip 35 Ne [Podružnica] Območje
BR CITY Kateri koli tip 35 Ne [Podružnica] Ime mesta institucije / podružnice
BR CPS Kateri koli tip 90 Ne [Podružnica] Okrožje, pokrajina, država ali druga upravna regija lastniške ustanove / podružnice
BR ZIP CODE Kateri koli tip 15 Ne [Podružnica] Poštna številka institucije / podružnice
BR POB NUMBER Kateri koli tip 35 Ne Polje, ločeno z vejico, ki vsebuje številko poštnega nabiralnika institucije / podružnice in z njo povezano poštno številko.
Primer
"POB 103352, 40024"
To strankam omogoča uporabo celotnega POB naslova:
POB 103352
40024, DUESSELDORF (CITY)
BRANCH INFORMATION Kateri koli tip 70 Ne Podatki o podružnici
To je prost opis podružnice, kot ga navaja finančna institucija, ki ji pripada. Zaenkrat bo to zagotovljeno samo za vnose v BIC in samo, če iskana finančna institucija želi zagotoviti te dodatne informacije. Informacije izvirajo iz BIC seznama.
COUNTRY NAME Kateri koli tip 70 Da Ime države institucije / podružnice, kot je navedeno v ISO 3166
ISO COUNTRY CODE Abecedno 2 Da ISO 3166-1 alfa-2 koda države institucije / podružnice
LOCATION CODE Kateri koli tip 1 Da Vsebuje lokacijo (uradno na 7. mestu standarda BIC: 2009)
Primeri:
• V FR, BIC v Parizu = P
• V BE, BIC v Bruslju = B
• V US, BIC na Vzhodni obali = 3
FIN SERVICE CODES Kateri koli tip 60 Ne FIN storitvene kode (imenujejo se tudi storitvene kode z dodano vrednostjo). Te kode so na voljo samo za zapise, ki vsebujejo BIC.
Polje lahko vsebuje do 20 kod, sestavljenih iz treh znakov, po abecednem vrstnem redu.
RECORD KEY BDP Alfanumerično 12 Ne Edinstven ključ zapisa Bank Directory Plus v datoteki.
FIELD A Kateri koli tip 1 Ne Rezervirano za možnost bodoče uporabe
FIELD B Kateri koli tip 64 Ne Rezervirano za možnost bodoče uporabe
FIELD C Kateri koli tip 128 Ne Rezervirano za možnost bodoče uporabe
FIELD D Kateri koli tip 256 Ne Rezervirano za možnost bodoče uporabe
FIELD E Kateri koli tip 11 Ne Rezervirano za možnost bodoče uporabe
FIELD F Kateri koli tip 12 Ne/td> Rezervirano za možnost bodoče uporabe
API sistem vrne rezultate v formatu XML, ki ga je možno enostavno razčleniti v različnih programskih jezikih in platformah.

Primer XML odgovora iz API-ja za iskanje BIC kode bi bil:


<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 ADDRESS CHANGED</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>FINANCIAL</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>LONDON</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/>
<br_street_address_4/>
<br_city/>
<br_cps/>
<br_zip_code/>
<br_pob_number/>
<branch_information>(ALL U.K. OFFICES)</branch_information>
<country_name>UNITED KINGDOM</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 napake

V primeru napake API vrne XML odgovor, ki vsebuje sporočilo o napaki.

XML oznake se v XML odgovoru vrnejo brez drugih polj.

Spodaj lahko najdete opis vseh možnih sporočil o napakah:

Status Tip Opis
301 Napaka računa API ključ ni veljaven
302 Napaka računa Naročnina je potekla
303 Napaka računa No queries available
304 Napaka računa Do tega API-ja nimate dostopa
401 Napaka pri vnosu Dovoljena dolžina SWIFT kode je 8 ali 11 znakov
402 Napaka pri vnosu Ime banke je nepravilno! Iskanje banke mora biti sestavljeno iz najmanj 4 znakov.
Dovoljeni znaki a-z, A-Z, 0-9, [space]!
403 Napaka pri vnosu Koda države ni pravilna! Dovoljeno je dvočrkovna koda države. Primer: UK, DE, FR