BIC / SWIFT-kodvalideringsAPI

Hur du integrerar BIC-valideringsAPIet i din mjukvara

1. Vad är BIC-valideringsAPIet?

När man behandlar överföringar och hanterar IBAN-relaterade transaktioner är det vitalt att ange korrekt SWIFT / BIC-kod för framgångsrika betalningar.
Vårt företag har licensierat den officiella BIC-katalogen från S.W.I.F.T SCRL för att tillhandahålla ett kraftfullt och enkelt sätt för att automatiskt validera BIC. Denna tjänst gör det möjligt för dig att integrera sökning i BIC-kodskatalogen i din mjukvara för internt bruk

BIC-valideringsAPIet har SWIFTRef-data inuti. BIC-data används med tillstånd från S.W.I.F.T. SCRL. Databasrättigheter förbehållna 2019

2. Funktioner

BIC-valideringsAPI nyckelfunktioner:

  • Hämta information avseende banken baserat på BIC.
  • Sök BIC-katalogen med en del av banknamnet och landet.
  • Sök BIC-katalogen för historik.
  • Använd både fullständigt och förenklat API-svar för enklare integration.


3. API-användande

BIC-valideringsAPIet är REST-baserat och stöder enkla HTTP GET eller POST-begäran.

Accepterade parametrar listas i tabellen nedan:

Fältnamn Längd Typ Beskrivning
bic 11 Sträng BIC / SWIFT-kod att söka. Kan vara 8 eller 11 tecken
bank_name 256 Sträng Del av banknamn för att utföra en sökning i BIC-katalogen.
country 2 Sträng Landskod på två bokstäver. Krävs när man söker via banknamn.
api_key 128 Sträng Din personliga API-nyckel.
format 4 Sträng Krävs för att specificera formatet på returnerad data. Värden som stöds för närvarande: json, xml
limit Integer Valfritt: kan användas för att begränsa antal svar när man söker via banknamn.
hist Integer Valfritt: kan användas för att visa historik från databasen för både bank och BIC-sökning.
Inuti din nätportal kan du hitta din API-nyckel och URL för begärans slutpunkt, vilken används för att säkerställa sökbegäran.


4. API XML Svarsstruktur

Du kan ladda ner ett XSD Schema för API-svaren.
En detaljerad beskrivning av returnerade fält kan ses i tabellen nedan:

Fältnamn Typ Längd Alltid närvarande Beskrivning
MODIFICATION FLAG Alfabetisk 1 Ja I deltafiler:
• A (tillägg)
• M (modifiering)
• D (radering) i fulla filer I fulla filer:
• A (tillägg)
CHANGED FIELD Numerisk 186 Nej Lagrar fält (eller TAG) som har ändrats antingen som ett resultat av en modifiering av en post eller som resultat av ett nytt EVENT.
En eller fler kolonner indikeras som en sekvens av siffror där varje nummer representerar kolonnen som ändrats från föregående postinstans eller föregående EVENT.
Exempel "6,7,8,9"
Detta betyder att EVENT TYPE, EVENT DATE, BIC8, och BRANCH BIC har
ändrats.
Följande FIELDS är exkluderade från att lagras i CHANGED FIELD:
• RECORD KEY
• CHANGED FIELD
• MODIFICATION FLAG
RECORD KEY Alfanumerisk 12 Ja Den unika nyckeln för posten i filen
Varje post representerar en händelse i livscykeln för ett BIC.
När den väl är tilldelad kommer RECORD KEY aldrig att ändras.
PREVIOUS RECORD KEY Alfanumerisk 12 Nej RECORD KEY för föregående länkade EVENT
Alla relaterade händelser är länkade och kan lokaliseras genom att använda denna information.
NEXT RECORD KEY Alfanumerisk 12 Nej RECORD KEY för nästa relaterade länkade händelse
Alla relaterade händelser är länkade och kan lokaliseras med denna information
EVENT TYPE Alfanumerisk 32 Ja EVENT eller förändringsbeskrivning relaterad till det BIC som inträffat tidigare, för närvarande, eller kommer att inträffa i framtiden.
Typer av händelser:
• 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
Sista uppdateringsdatum är den sista linjen i BIC-sekvensen (dvs den senaste inmatningen).
När en ny EVENT läggs till kommer MODIFICATION FLAG och CHANGED
FIELD-kolonnerna att uppdateras i den omedelbart föregående relaterade EVENT.
EVENT DATE Alfanumerisk 8 Ja Datum för EVENT
BIC8 Alfanumerisk 8 Ja BIC (institut, land och partsuffix) där:
• Partprefix (4 tecken)
• Landskod (2 tecken)
• Partsuffix (2 tecken)
BRANCH BIC Alfanumerisk 3 Ja BIC filialidentifierare associerad med 8-teckens BIC. Om ingen filialidentifierare existerar används XXX.
BIC Alfanumerisk 11 Ja Fullständig BIC: 8-tecken BIC och filialidentifierare
RECORD STATUS Alfabetisk 1 Ja Indikerar poststatus:
• [C] = Nuvarande representerar den senaste händelsen i kedjan fram till publikationsdatum, exklusive [F]ramtida händelser
• [H] = Historiska poster i händelsekedjan
• [F] = Framtida händelse som kommer att inträffa efter katalogens publikationsdatum. Den tidigare indikerade [C]nuvarande händelsen kommer att vara giltig fram till det datum som specificeras i den [F]ramtida händelsen.
För FUTURE händelser indikerar datum när förändringen kommer att vara VALID FROM.
OPERATIONALLY ACTIVE RECORD Alfa 1 Ja Det finns multipla poster för samma BIC. Detta fält indikerar vilken av posterna för samma BIC som är den operationellt aktiva BIC och ska användas.
• [Y] Operationellt aktiv
• [N] Operationellt inaktiv
För varje unik BIC finns det en enskild postinmatning som indikerar ACTIVE status (Y).
Poster med [H]istorisk status kommer alltid att indikera [N].
Poster med [C]nuvarande kan komma att indikera [Y] eller [N].
Poster med [F] kommer alltid att indikera [N].
SUBTYPE INDICATOR Vilken typ som helst 4 Ja Affärstypen för enheten. Undertypsindikator tillhandahålls enbart för poster med en BIC.
SWIFT FIN Alfabetisk 1 Ja Status på en enhets uppkoppling till FIN:
• [Y] uppkopplad till FIN
• [N] inte uppkopplad till FIN
SWIFT FA Alfabetisk 1 Ja Status på en enhets nåbarhet genom FileAct:
• [Y] uppkopplad till FileAct
• [N] inte uppkopplad till FileAct
SWIFT IA Alfa 1 Ja Status på en enhets nåbarhet genom InterAct:
• [Y] uppkopplad till InterAct
• [N] inte uppkopplad till InterAct
LEGAL NAME Vad som helst 105 Nej Institutets juridiska namn
INSTITUTION NAME Any 105 Ja Instituts handelsnamn (publicerat namn)
INSTITUTION TYPE Alfabetisk 12 Ja Organisation som i huvudsak är engagerad i finansiell förmedling och/eller finansiell serviceverksamhet
Institutstyp:
• FINANCIAL
• NONFINANCIAL
ENTITY TYPE ALfabetisk 16 Ja Identifierar typen av finansiell enhet:
• Juridisk person
• Filial
• Operationell
RE STREET ADDRESS 1 Vad som helst 35 Nej [Registrerad] Gatuadress
RE STREET ADDRESS 2 Vad som helst 35 Nej [Registrerat] Gatunummer
RE STREET ADDRESS 3 Vad som helst 35 Nej [Registrad] Byggnad, byggnadsnam, våning
RE STREET ADDRESS 4 Vad som heslt 35 Nej [Registrerat] Område
RE CITY Vad som heslt 35 Nej [Registrerat] Stad för institutet/filialen
RE CPS Vad som heslt 90 Nej [Registrerat] Land, provins, stat eller annan administrativ region för ägande institut/filial
RE ZIP CODE Vad som helst 15 Nej [Registrerat] Postnummer för institut/filial
RE POB NUMBER Vad som heslt 35 Nej Kommaseparerade fält med POB-nummer för institutet/filialen och relaterat postnummer.
Exempel
"POB 103352, 40024"
Detta gör det möjligt för kunder att använda den fullständiga POB-adressen:
POB 103352
40024, DUESSELDORF (CITY)
OP STREET ADDRESS 1 Vad som helst 35 Nej [Operationell] Gatuadress
OP STREET ADDRESS 2 Vad som helst 35 Nej [Operationellt] Gatunummer
OP STREET ADDRESS 3 Vad som helst 35 Nej [Operationell] Byggnad, byggnadsnamn, våning
OP STREET ADDRESS 4 Vad som helst 35 Nej [Operationellt] Område
OP CITY Vad som helst 35 Nej [Operationell] stad för institutet/filialen
OP CPS Vad som helst 90 Nej [Operationellt] Land, provins, stat eller annan administrativ region för ägande institut/filial
OP ZIP CODE Vad som helst 15 Nej [Operationellt] Postnummer för institut/ filial
OP POB NUMBER Vad som helst 35 Nej Kommaseparerade fält med POB-nummer för institutet/filialen och relaterat postnummer.
Exempel
"POB 103352, 40024"
Detta gör det möjligt för kunder att använda den fullständiga POB-adressen:
POB 103352
40024, DUESSELDORF (CITY)
BR STREET ADDRESS 1 Vad som helst 35 Nej [Filial] Gatuadress
BR STREET ADDRESS 2 Vad som helst 35 Nej [Filial] Gatunummer
BR STREET ADDRESS 3 Vad som helst 35 Nej [Filial] Byggnad, byggnadsnamn, våning
BR STREET ADDRESS 4 Vad som helst 35 Nej [Filial] Område
BR CITY Vad som helst 35 Nej [Filial] Stad för institut/ filial
BR CPS Vad som helst 90 No [Filial] Land, provins, stat eller annan administrativ region för ägande institut/filial
BR ZIP CODE Vad som helst 15 Nej [Filial] Postnummer för institut/filial
BR POB NUMBER Vad som helst 35 Nej Kommaseparerade fält med POB-nummer för institutet/filialen och relaterat postnummer.
Exempel
"POB 103352, 40024"
Detta gör det möjligt för kunder att använda den fullständiga POB-adressen:
POB 103352
40024, DUESSELDORF (CITY)
BRANCH INFORMATION Vad som helst 70 Nej Filialinformation
Detta är en fri beskrivning av filialen givet av finansinstitutet till vilket den tillhör. För närvarande tillhandahålls denna bara för inmatningar med en BIC och bara när finansinstitutet i fråga vill ge denna extra information. Informationens källa är BIC-katalogen.
COUNTRY NAME Vad som helst 70 Ja Institutets/filialens land enligt indikation följandes ISO 3166
ISO COUNTRY CODE Alfabetisk 2 Ja ISO 3166-1 alfa-2-kod för institutets/filialens land
LOCATION CODE Vad som helst 1 Ja Innehåller platsen (formellt i position 7 enligt BIC standard:2009)
Exempel:
• I FR, BIC in Paris = P
• I BE, BIC in Bryssel = B
• I US, BIC på östkusten = 3
FIN SERVICE CODES Vilken typ som helst 60 Nej FIN-tjänstkoder (även kallade tjänstekoder för mervärde). Tjänstekoder tillhandahålls enbart för poster som innehåller en BIC.
Fältet kan innehålla upp till 20 treteckenskoder i alfabetisk ordning.
RECORD KEY BDP Alfanumerisk 12 Nej Den unika nyckeln för Bank Directory Plus-poster i filen.
FIELD A Vad som helst 1 Nej Reserverad för framtida bruk
FIELD B Vad som helst 64 Nej Reserverad för framtida bruk
FIELD C Vad som helst 128 Nej Reserverad för framtida bruk
FIELD D Vad som helst 256 Nej Reserverad för framtida bruk
FIELD E Vad som helst 11 Nej Reserverad för framtida bruk
FIELD F Vad som helst 12 Nej Reserverad för framtida bruk
API-systemet returnerar resultat i XML-format, vilket är lätt att tolka i ett antal programmeringsspråk och plattformar.

Ett exempel på ett XML-svar från APIet för en BIC-sökning skulle vara:


<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-fel

Vid fel returnerar APIet ett XML-svar som innehåller felmeddelandet.

XML-taggarna returneras utan andra fält i XML-svaret.

Nedan kan du finna en beskrivning på alla möjliga felmeddelanden som kan returneras:

Statuskod Typ Beskrivning
301 Kontofel API-nyckel är ogiltig
302 Kontofel Abonnemang har löpt ut
303 Kontofel Inga sökningar tillgängliga
304 Kontofel Du har ingen åtkomst av detta API
401 Inmatningsfel Accepterad SWIFT-längd 8 eller 11 tecken'
402 Inmatningsfel Banknamn ogiltigt! Banksökning ska vara minst 4 tecken.
Tillåtna tecken a-z, A-Z, 0-9, [mellanslag]!
403 Inmatningsfel Fel landskod! Landskoder på 2 tecken tillåtna. Exempel: UK, DE, FR