IBAN kalkulering API dokumentering
denne API er del av vår IBAN Suite tjeneste
API integrerings guide
1. hva er IBAN kalkulerings API?
IBAN kalkulerings ( AKA IBAN konversjon ) motor er et programvare system som lar våre klienter konvertere domestiske bank koder og konto nummer kombinasjoner til validerte internasjonale bank konto nummer ( IBAN ).
systemet tillater våre klienter manuell interface i tilleg til en API for å tillate integrering i deres bedrifts interne systemer.
systemet identifiserer også banker og finnansielle institusjoner og tilbyr detaljer til våre kunder.
2. funksjoner
under er noen av hoved funksjonene av vår IBAN kalkulerings motor:
- Valider lokal bank kode / konto nummer sjekk summer ( * sjekk støttede land )
- få tilbake informasjon om banken basert på den lokale bank/gren koden.
- genererer automatisk et valid IBAN format for den utleverte bank/gren koden og konto nummer
- Systemet støtter fler svar format ( JSON / XML )
3. støttede land
IBAN kalkulerings API støtter de følgende landene og skjemaene krevd av vår API for å kalkulere en IBAN.
land kode |
land navn |
bank kode |
gren |
konto |
sjekk nummer ** |
AT |
Austria |
YES |
|
YES |
|
BE |
Belgium |
YES |
|
YES |
YES |
CH |
Switzerland |
YES |
|
YES |
|
DE |
Deutschland |
YES |
|
YES |
|
EE |
Estonia |
|
|
YES |
|
ES |
Spain |
YES |
YES |
YES |
YES |
FI |
Finland |
|
|
YES |
YES |
FR |
France |
YES |
YES |
YES |
YES |
GB |
Great Britain |
YES |
|
YES |
YES |
HU |
Hungary |
|
|
YES |
YES |
IE |
Ireland |
YES |
|
YES |
YES |
IT |
Italy |
YES |
YES |
YES |
YES |
MC |
Monaco |
YES |
YES |
YES |
YES |
MR |
Mauritania |
YES |
YES |
YES |
|
MT |
Malta |
YES |
|
YES |
|
NO |
Norway |
|
|
YES |
YES |
PT |
Portugal |
YES |
YES |
YES |
YES |
SM |
San Marino |
YES |
YES |
YES |
|
CZ |
Czech Republic |
YES |
|
YES |
YES |
AL |
Albania |
YES |
|
YES |
|
SK |
Slovak Republic |
YES |
|
YES |
YES |
SI |
Slovenia |
YES |
|
YES |
YES |
PL |
Poland |
YES |
|
YES |
YES |
PK |
Pakistan |
YES |
|
YES |
|
SE |
Sweden |
YES |
|
YES |
YES |
NL |
Netherlandds |
|
|
YES |
YES |
sjekk nummer kolonnen spessifiserer om landet støtter konto nummer og/eller bank kode sjekk nummer validering.
sjekk nummer valideringen er et ekstra lag med data integretets beskyttelse mot skrive feil.
4. API Input
API aksepterer både HTTP GET og POST forespørsel for input data.
de aksepterte måtene er oppgitt i listen under:
felt navn |
Type |
beskrivelse |
api_key |
String |
din personlige API nøkkel. finnes i klient området. |
format |
String |
API respons format ( xml eller json ) |
land |
String |
2 bokstavs land kode ( UK/US/DE/FR ) |
bank kode |
String |
en unik bank identifiserer. forskjellig for hvert land. ( valgfri ). noen land trenger bare konto nummer. |
gren |
String |
en unik lokal gren identifiserer ( valgfri ) |
konto |
String |
personlig konto nummer |
cd |
integer |
sjekk nummer brukt i noen land. |
prefix |
Integer |
bare nødvendig for tsjekkia ( valgfri ) |
første argument er api koden, denne unike stringen som hjelper vårt system med å identifisere deg som bruker og gir deg tilgang til API.
API støtter flersvar format for å tilby lettere integrering. for øyeblikket, er XML og JSON støttet.
land argumenter må inneholde en 2 bokstavs ISO lands kode sånn som UK for United Kingdom, DE for gremany, FR for France …
bank koden har forskjellig lengde og struktur for hvert land.
gren kode er et valgfritt argument som bare kreves for noen land ( referer til eksempler )
konto nummer er nødvendig for alle land og i noen tilfeller er det det eneste parameteret brukt for å kalkulere en IBAN.
sjekk nummer er kun nødvendig for noen land som har fått slik validerings algorytme i deres bank konto nummer struktur. ( referer til eksempler )
Prefix er et valgfritt skjema for tjekkisk IBAN kalkulering.
5. API Eksempler
i listen under finner du eksempelet på GET kø på vår API for hvert land.
land |
Eksempel kø (få forespørsel) |
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
en detaljert beskrivelse av mulige skjemaer retunert kan bli sett under:
skjema navn |
Type |
beskrivelse |
addresse |
String |
Addresse til bank grenen eller hovedkvarteret |
bank |
String |
Navnet til banken eller finansiell institusjon |
bic |
String |
BIC ( Bank Identifier Code ) til banken |
gren |
String |
gren navnet identifisert av bank koden |
by |
String |
navnet på byen hvor grenen er lokalisert. |
land |
String |
to bokstavs forkortelse til landets kode e.g. US, UK, AU, FR … etc. |
email |
String |
tilordnet kontakt email addresse for banken eller grenen |
fax |
String |
Fax nummer av banken/grenen |
telefon |
String |
kontakt telfon nummer til banken / grenen |
stat |
String |
Staten til bank/gren addressen |
nettside |
String |
nettsiden til banken / grenen |
zip |
String |
ZIP eller post koden til bank/gren addressen |
API systemet returnerer resultater i XML eller JSON format,som er lett å bruke i en variasjon av programerings språk og platformer.
et eksempel XML svar fra API for United Kingdom SORT kode og konto nummer søk ville være:
kø 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>
svaret for den samme køen om brukeren spesifiserer en JSON formatering vil 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 feil
om det skulle skje en feil vil IBAN kalkuleringen API retunere en XML eller JSON respons som inneholder feil meldingen.
<error></error> XML tagsene blir returnert uten noen andre skjemaer i XML svaret.
under kan du finne en beskrivelse over alee mulige feil meldinger som kan bli retunert:
<error>konto nummer checksum er ugyldig.</error>
<error>konto nummer (checksum) er ikke riktig.</error>
<error>konto nummer må være 11 tegn langt</error>
<error>konto nummer må være 14 tegn langt</error>
<error>konto nummer må være 24 tegn langt</error>
<error>konto nummer er ikke gyldig</error>
<error>konto nummer til sorterings koden er ikke gyldig</error>
<error>konto nummer prefix for langt.</error>
<error>konto nummer for langt.</error>
<error>Bank/gren kode / KIB (checksum) er ikke riktig.</error>
<error>Bank kode/ gren kode/ konto nummer for langt.</error>
<error>Bank kode/ gren kode (checksum) er ikke riktig.</error>
<error>Bank kode ikke gyldig</error>
<error>Bank kode for lang.</error>
<error>Bank ikke funnet</error>
<error>Bank ikke gjennskjent</error>
<error>BBAN / NIB (checksum) er ikke riktig.</error>
<error>BLZ/Bank kode ikke gyldig</error>
<error>gren/byrå ikke funnet</error>
<error>gren kode for lang.</error>
<error>gren ikke funnet</error>
<error>Check nummer for langt.</error>
<error>klarings nummer/konto nummer er ikke gyldig. Check nummer ugyldig.</error>
<error>klarings nummer / bank kode kan ikke identifiseres. IBAN kan ikek bli kalkulert.</error>
<error>klarings nummer eller konto nummer for langt.</error>
<error>Codice ABI della Banca/Bank kode ikke gyldig</error>
<error>Codice CAB della Filiale/gren kode ikke gyldig</error>
<error>land kode er ikke gyldig</error>
<error>land eller banker ikke støttet</error>
<error>IBAN er ikke gyldig</error>
<error>Kontonummer/konto nummer er ikek gyldig</error>
<error>manglende skjema</error>
<error>ikke FR IBAN</error>
<error>ikke FR IBAN land</error>
<error>nødvendige skjemaer mangler. vennligst skriv inn bank kode og konto nummer</error>
<error>nødvendige skjemaer ikke levert.</error>
<error>RIB er ikke gyldig</error>
<error>Sort kode / Bank kode kan ikke bli identifisert. IBAN kan ikke bli kalkulert.</error>
<error>Sort kode kan ikke bli funnet</error>