DK
Denne API er en del af vores IBAN Suite tjeneste
API integreringsvejledning
1. Hvad er en IBAN beregnings-API?
IBAN Beregningsværktøjet ( AKA IBAN konverteringsværktøjet) er et software system, der giver vores klienter mulighed for at konvertere indenrigs kombinationer af bankkoder og kontonumre til validerede Internationale Bank Kontonumre (IBAN).Systemet gør det muligt for vores klienter at bruge både en manuel brugerflade og en API til integrering i deres virksomheds interne systemer.
Systemet identificerer også banker og finanshuse og giver vores kunder oplysninger.
2. Funktioner
Herunder er nogle af de vigtigste funktioner for vores IBAN Beregningsværktøj:- Valider lokale bankkode/kontonummer kontrolsummer (*se Understøttede Lande)
- Hent bankoplysninger baseret på den lokale bank/filial kode.
- Generer automatisk et gyldigt IBAN-format for den angivne bank/filial kode og kontonummeret
- Systemet understøtter formatering af flere responser ( JSON / XML )
3. Understøttede lande
IBAN Beregnings-API’en understøtter i øjeblikket følgende lande og de felter, vores API kræver for at beregne et IBAN-nummer.| Landekode | Landenavn | Bankkode | Filial | Konto | Kontroltal** |
|---|---|---|---|---|---|
| AT | Østrig | JA | JA | ||
| BE | Belgien | JA | JA | JA | |
| CH | Scweiz | JA | JA | ||
| DE | Tyskland | JA | JA | ||
| EE | Estland/td> | JA | |||
| ES | Spanien | JA | JA | JA | JA |
| FI | Finland | JA | JA | ||
| FR | Frankrig | JA | JA | JA | JA |
| GB | Storbritannien | JA | JA | JA | |
| HU | Ungarn | JA | JA | ||
| IE | Irland | JA | JA | JA | |
| IT | Italien | JA | JA | JA | JA |
| MC | Monaco | JA | JA | JA | JA |
| MR | Mauritanien | JA | JA | JA | |
| MT | Malta | JA | JA | ||
| NO | Norge | JA | JA | ||
| PT | Portugal | JA | JA | JA | JA |
| SM | San Marino | JA | JA | JA | |
| CZ | Tjekkiet | JA | JA | JA | |
| AL | Albanien | JA | JA | ||
| SK | Slovakiet | JA | JA | JA | |
| SI | Slovenien | JA | JA | JA | |
| PL | Polen | JA | JA | JA | |
| PK | Pakistan | JA | JA | ||
| SE | Sverige | JA | JA | JA | |
| NL | Holland | JA | JA |
Validering med kontroltal er et ekstra lags beskyttelse af data integriteten mod indtastningsfejl.
4. API Input
API accepterer både HTTP GET og POST anmodninger om input data.De accepterede parametre er angivet i skemaet herunder:
| Feltnavn | Type | Beskrivelse |
|---|---|---|
| api_nøgle | Streng | Din personlige API nøgle. Fås i klientområdet. |
| format | Streng | API responsformat (xml eller json) |
| land | Streng | Landekode på 2 bogstaver (UK/US/DE/FR) |
| bankkode | Streng | En unik bank-identifikator. Forskellig for hvert land. (Valgfri). Visse lande kræver kun kontonummer. |
| filial | Streng | En unik lokal filial-identifikator (valgfri) |
| konto | Streng | Personligt kontonummer |
| cd | heltal | Kontroltal, der bruges i visse lande. |
| præfiks | Heltal | Kræves i øjeblikket kun for Tjekkiet ( valgfrit ) |
API’en understøtter flere responsformater for at levere lettere integrering. I øjeblikket understøttes XML og JSON.
Landeargumenter skal bestå af en ISO landekode på 2 bogstaver, såsom UK for Storbritannien, DE for Tyskland, FR for Frankrig, osv
Bankkoder har forskellige længder og strukturer for hvert land.
Filial kode er et valgfrit argument, som kun kræves for visse lande (henvis til eksempler)
Kontonummer er påkrævet for alle lande og er i visse tilfælde den eneste parameter brugt til beregning af et IBAN.
Kontroltal kræves kun for visse lande, der har indbygget sådanne valideringsalgoritmer i strukturen af deres indenrigs bankkontonumre (henvis til eksempler)
Præfiks er et valgfrit felt, som kun er påkrævet for tjekkiske IBAN beregninger.
5. API eksempler
I skemaet herunder finder du eksempler på fungerende GET forespørgsler til vores API for hvert land.| Land | Eksempel på forespørgsel (GET ANMODNING) |
|---|---|
| AT | ?country=AT&format=json&bankcode=12000&account=52700357958 |
| BE | ?country=BE&format=json&bankcode=250&account=0135106&cd=70 |
| CH | ?country=CH&format=json&bankcode=0240&account=240C08011570 |
| DE | ?country=DE&format=json&bankcode=BLZ37010050&account=399509 |
| EE | ?country=EE&format=json&account=55000005511439 |
| ES | ?country=ES&format=json&bankcode=0081&branch=1731&cd=91&account=0006040912 |
| FI | ?country=FI&format=json&account=52900261901092 |
| FR | ?country=FR&format=json&bankcode=30056&branch=00264&account=02640016443 |
| GB | ?country=GB&format=json&bankcode=090127&account=93496333 |
| HU | ?country=HU&format=json&account=107000240416330551100005 |
| IE | ?country=IE&format=json&bankcode=905838&account=71924374 |
| IT | ?country=IT&format=json&country=IT&bankcode=02008&branch=30545&account=000103685854 |
| MC | ?country=MC&format=json&country=MC&bankcode=30002&branch=03260&account=0000079112A |
| MR | ?country=MR&format=json&bankcode=00012&branch=00001&account=00000078326 |
| MT | ?country=MT&format=json&bankcode=07113&account=199008240010 |
| NO | ?country=NO&format=json&account=96803502045 |
| PT | ?country=PT&format=json&bankcode=0038&branch=0000&cd=81&account=39551148771 |
| PK | ?country=PK&format=json&bankcode=HABBPKKA&account=39551148771 |
| SE | ?country=SE&format=json&bankcode=9150&account=0092395696 |
| SM | ?country=SM&format=json&country=SM&bankcode=03034&branch=09800&account=000060164676 |
| CZ | ?country=CZ&format=json&prefix=51&account=1707230277&bankcode=0100 |
| AL | ?country=AL&format=json&bankcode=20511117&account=374362CLPRCFEURC |
| SK | ?country=SK&format=json&prefix=&account=4110053902&bankcode=3100 |
| SI | ?country=SI&format=json&bankcode=33000&account=0000102423 |
| PL | ?country=PL&format=xml&bankcode=11402004&account=0000360275244226 |
| SE | ?country=SE&format=json&bankcode=9300&account=5913222524 |
| NL | ?country=NL&format=json&account=0006642318 |
6. API XML respons struktur
A detailed description of the possible fields returned can be seen in the table below:| Feltnavn | Type | Beskrivelse |
|---|---|---|
| adresse | Streng | Adresse på bankens filial eller hovedkvarter |
| bank | Streng | Navn på banken eller finanshuset |
| bic | Streng | Bankens BIC (Bank Identifier Code) |
| filial | Streng | Navn på den filial, der identificeres af bankkoden |
| by | Streng | Navn på byen, hvor filialen ligger. |
| land | Streng | Forkortelse af landekoden på to bogstaver, fx US, UK, AU, FR osv. |
| Streng | Tildelt kontaktmail til banken eller filialen | |
| fax | Streng | Fax nummer til banken/filialen |
| telefon | Streng | Kontakt telefonnummer til banken/filialen |
| stat | Streng | Stat for bankens/filialens adresse |
| websted | Streng | Webstedsadressen for banken/filialen |
| postnummer | Streng | Postnummer for bankens/filialens adresse |
Et eksempel på et XML svar fra API’en for en britisk SORT kode og Kontonummer søgning ville være:
Forespørgsels-URL:
?api_key=9834hAHx78ba4g8habsdk&country=GB&format=json&bankcode=110377&account=10218962
<result>
<iban>GB20ULSB98006054100029</iban>
<account>54100029</account>
<sort_code>980060</sort_code>
<bank>ULSTER BANK LTD</bank>
<branch>BELFAST CITY OFFICE 1</branch>
<bic>ULSBGB2BXXX</bic>
<address>PO BOX 232 11-16 DONEGALL SQUARE EAST </address>
<city>BT1 5UB</city>
<country>GB<country/>
<phone>028 90244112</phone>
</result>
Responsen for samme forespørgsel, hvis brugeren specificerede JSON formatting ville være:
"iban":"GB20ULSB98006054100029","account":"54100029","sort_code":"980060","bank":"ULSTER BANK LTD","branch":"BELFAST CITY OFFICE 1","bic":"ULSBGB2BXXX","address":"PO BOX 232 11-16 DONEGALL SQUARE EAST ","city":"BT1 5UB","country":"GB","phone":"028 90244112"
7. API fejl
I tilfælde af fejl sender IBAN Beregnings API’en en XML eller JSON respons, der indeholder fejlmeddelelsen.The <error></error> XML tags sendes tilbage uden andre felter i XML responsene.
Herunder finder du en beskrivelse af alle mulige fejlmeddelelser, man kan få tilbage:
<error>Kontrolsum for kontonummeret er ugyldig.</error>
<error>Kontonummer (checksum) er ikke korrekt.</error>
<error>Kontonummer skal være på 11 tegng</error>
<error>Kontonummer skal være på 14 tegn</error>
<error>Kontonummer skal være på 24 tegn</error>
<error>Kontonummer er ugyldigt</error>
<error>Kontonummer for sortkoden er ugyldigt</error>
<error>Kontonummer præfiks er for langt.</error>
<error>Kontonummer er for langt.</error>
<error>Bank/filial kode / KIB (kontrolsum) er ikke korrekt.</error>
<error>Bankkode/filialkode/kontonummer er for langt.</error>
<error>Bankkode/filialkode (kontrolsum) er ikke korrekt.</error>
<error>Bankkode ikke gyldig</error>
<error>Bankkode er for lang.</error>
<error>Bank ikke fundet</error>
<error>Bank ikke genkendt</error>
<error>BBAN/NIB (kontrolsum) er ikke korrekt.</error>
<error>BLZ/Bankkode ikke gyldig</error>
<error>Filial/agentur ikke fundet</error>
<error>Filialkode er for lang.</error>
<error>Filial ikke fundet</error>
<error>Kontroltal er for langt.</error>
<error>Clearingnummer/kontonummer er ugyldigt. Kontroltal forkert.</error>
<error>Clearingnummer/bankkode kan ikke identificeret. IBAN kan ikke beregnes.</error>
<error>Clearingnummer eller kontonummer er for langt.</error>
<error>ABI-koden for banken/bankkoden er ikke gyldig</error>
<error>CAB-koden for filialen/filialkoden er ikke gyldig</error>
<error>Landekoden er ikke gyldigd</error>
<error>Landet eller banken understøttes ikke</error>
<error>IBAN er ikke gyldigt</error>
<error>Kontonummeret er ikke gyldigt</error>
<error>Manglende felter</error>
<error>Intet FR IBAN</error>
<error>Intet FR IBAN land</error>
<error>Påkrævet felt mangler. Indtast venligst Bankkode og Kontonummer</error>
<error>Påkrævede felter ikke udfyldt.</error>
<error>RIB er ugyldig</error>
<error>Sortkode/bankkode kan ikke identificeres. IBAN kan ikke beregnes.</error>
<error>Sortkode kan ikke findes</error>