GR
Αυτό το API είναι μέρος της υπηρεσίας μας IBAN Suite
Οδηγός ενσωμάτωσης API
1. Τι είναι το API Υπολογισμού IBAN;
Η μηχανή υπολογισμού IBAN (επίσης αναφερόμενη ως Εργαλείο Μετατροπής IBAN) είναι ένα σύστημα λογισμικού που επιτρέπει στους πελάτες μας να μετατρέπουν τους συνδυασμούς κωδικών τραπεζικών λογαριασμών και αριθμών λογαριασμού σε έγκυρους Διεθνείς Αριθμούς Τραπεζικού Λογαριασμού ( IBAN ).Το σύστημα επιτρέπει στους πελάτες μας χειροκίνητο περιβάλλον εργασίας καθώς και ένα API που επιτρέπει την ενσωμάτωση στα εσωτερικά συστήματα της εταιρείας τους.
Το σύστημα εντοπίζει επίσης τις τράπεζες και τα χρηματοπιστωτικά ιδρύματα και παρέχει τις λεπτομέρειες στους πελάτες μας.
2. Χαρακτηριστικά
Παρακάτω δίνονται μερικά από τα βασικά χαρακτηριστικά της μηχανής Υπολογισμού IBAN:- Επαλήθευση του τοπικού κωδικού τράπεζας / ελέγχου αθροίσματος αριθμού λογαριασμού ( * δείτε Υποστηριζόμενες Χώρες )
- Ανάκτηση πληροφοριών σχετικά με την τράπεζα με βάση τον τοπικό κωδικό τράπεζας/υποκαταστήματος.
- Δημιουργεί αυτόματα μια έγκυρη μορφή IBAN για τον παρεχόμενο κωδικό τράπεζας/υποκαταστήματος και αριθμό λογαριασμού
- Το σύστημα υποστηρίζει πολλαπλές μορφές απάντησης ( JSON / XML )
3. Υποστηριζόμενες Χώρες
Το API υπολογισμού IBAN υποστηρίζει προς το παρόν τις ακόλουθες χώρες και τα πεδία που απαιτούνται από το API μας για τον υπολογισμό ενός IBAN.| Κωδικός Χώρας | Όνομα Χώρας | Κωδικός Τράπεζας | Υποκατάστημα | Λογαριασμός | Έλεγχος Ψηφίων ** |
|---|---|---|---|---|---|
| AT | Αυστρία | ΝΑΙ | ΝΑΙ | ||
| BE | Βέλγιο | ΝΑΙ | ΝΑΙ | ΝΑΙ | |
| CH | Ελβετία | ΝΑΙ | ΝΑΙ | ||
| DE | Γερμανία | ΝΑΙ | ΝΑΙ | ||
| EE | Εσθονία | ΝΑΙ | |||
| ES | Ισπανία | ΝΑΙ | ΝΑΙ | ΝΑΙ | ΝΑΙ |
| FI | Φινλανδία | ΝΑΙ | ΝΑΙ | ||
| FR | Γαλλία | ΝΑΙ | ΝΑΙ | ΝΑΙ | ΝΑΙ |
| GB | Μεγάλη Βρετανία | ΝΑΙ | ΝΑΙ | ΝΑΙ | |
| HU | Ουγγαρία | ΝΑΙ | ΝΑΙ | ||
| IE | Ιρλανδία | ΝΑΙ | ΝΑΙ | ΝΑΙ | |
| IT | Ιταλία | ΝΑΙ | ΝΑΙ | ΝΑΙ | ΝΑΙ |
| MC | Μονακό | ΝΑΙ | ΝΑΙ | ΝΑΙ | ΝΑΙ |
| MR | Μαυριτανία | ΝΑΙ | ΝΑΙ | ΝΑΙ | |
| MT | Μάλτα | ΝΑΙ | ΝΑΙ | ||
| ΟΧΙ | Νορβηγία | ΝΑΙ | ΝΑΙ | ||
| PT | Πορτογαλία | ΝΑΙ | ΝΑΙ | ΝΑΙ | ΝΑΙ |
| SM | Σαν Μαρίνο | ΝΑΙ | ΝΑΙ | ΝΑΙ | |
| CZ | Τσέχικη Δημοκρατία | ΝΑΙ | ΝΑΙ | ΝΑΙ | |
| AL | Αλβανία | ΝΑΙ | ΝΑΙ | ||
| SK | Σλοβάκικη Δημοκρατία | ΝΑΙ | ΝΑΙ | ΝΑΙ | |
| SI | Σλοβενία | ΝΑΙ | ΝΑΙ | ΝΑΙ | |
| PL | Πολωνία | ΝΑΙ | ΝΑΙ | ΝΑΙ | |
| PK | Πακιστάν | ΝΑΙ | ΝΑΙ | ||
| SE | Σουηδία | ΝΑΙ | ΝΑΙ | ΝΑΙ | |
| NL | Ολλανδία | ΝΑΙ | ΝΑΙ |
Η επικύρωση των ψηφίων ελέγχου είναι ένα επιπλέον στρώμα προστασίας της ακεραιότητας των δεδομένων έναντι τυπογραφικών σφαλμάτων.
4. Εισαγωγές API
Το API αποδέχεται HTTP GET και POST αιτήματα για εισαγωγή δεδομένων.Οι αποδεκτές παράμετροι παρατίθενται στον παρακάτω πίνακα:
| Όνομα Πεδίου Name | Είδος | Περιγραφή |
|---|---|---|
| κλειδί_api | String | Το προσωπικό σας κλειδί API. Λαμβάνεται στη ζώνη πελάτη. |
| μορφή | String | μορφή απόκρισης API ( xml or json ) |
| χώρα | String | κωδικός χώρας με 2 γράμματα ( UK/US/DE/FR ) |
| κωδικός τράπεζας | String | Ένα μοναδικό αναγνωριστικό τράπεζας. Διαφορετικό για κάθε χώρα. (προαιρετικό). Ορισμένες χώρες χρειάζονται μόνο τον αριθμό λογαριασμού. |
| υποκατάστημα | String | Ένα μοναδικό αναγνωριστικό τοπικού υποκαταστήματος ( προαιρετικό ) |
| λογαριασμός | String | Προσωπικός αριθμός λογαριασμού |
| cd | Ακέραιος | Ψηφία Ελέγχου που χρησιμοποιούνται σε μερικές χώρες. |
| πρόθεμα | Ακέραιος | Αυτή τη στιγμή απαραίτητο μόνο για τη Τσέχικη Δημοκρατία ( προαιρετικό ) |
Το API υποστηρίζει πολλαπλές μορφές απόκρισης για την ευκολότερη ενσωμάτωση. Επί του παρόντος υποστηρίζονται οι XML και JSON.
Τα επιχειρήματα χώρας πρέπει να συνίστανται από έναν κωδικό χώρας 2 γραμμάτων ISO, όπως UK για το Ηνωμένο Βασίλειο, DE για τη Γερμανία, FR για τη Γαλλία …
Ο Κωδικός Τράπεζας έχει διαφορετικό μήκος και διαμόρφωση για κάθε χώρα.
Ο Κωδικός Υποκαταστήματος είναι ένα προαιρετικό επιχείρημα που απαιτείται μόνο για ορισμένες χώρες ( ανατρέξτε στα Παραδείγματα )
Ο αριθμός λογαριασμού απαιτείται για όλες τις χώρες και σε ορισμένες περιπτώσεις είναι η μόνη παράμετρος που χρησιμοποιείται για τον υπολογισμό ενός IBAN.
Ο Έλεγχος ψηφίων απαιτείται μόνο για ορισμένες χώρες που έχουν ενσωματώσει τέτοιους αλγόριθμους επικύρωσης στη διαμόρφωση των τοπικών αριθμών τραπεζικών λογαριασμών. ( ανατρέξτε στα Παραδείγματα )
Το πρόθεμα είναι ένα πεδίο που προαιρετικά απαιτείται μόνο για τον υπολογισμό IBAN της Τσεχικής Δημοκρατίας.
5. Παραδείγματα API
Στον παρακάτω πίνακα μπορείτε να βρείτε παραδείγματα εργασίας του αιτήματος GET στο API μας για κάθε χώρα.| Χώρα | Παράδειγμα αιτήματος (ΑΙΤΗΜΑ GET) |
|---|---|
| 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. Δομή Απόκρισης XML του API
Μια λεπτομερής περιγραφή των πιθανών πεδίων που επιστρέφονται μπορεί να βρεθεί στον παρακάτω πίνακα:| Όνομα Πεδίου | Είδος | Περιγραφή |
|---|---|---|
| διεύθυνση | String | Διεύθυνση του υποκαταστήματος της τράπεζας ή των κεντρικών |
| τράπεζα | String | Όνομα τράπεζας ή οικονομικού ιδρύματος |
| bic | String | BIC ( Κωδικός Ταυτοποίησης Τράπεζας ) τράπεζας |
| υποκατάστημα | String | Όνομα του υποκαταστήματος που ταυτοποιήθηκε από τον κωδικό τράπεζας |
| πόλη | String | Το όνομα της πόλης στην οποία βρίσκεται το υποκατάστημα. |
| χώρα | String | Συντομογραφία με δύο γράμματα του κωδικού χώρας πχ. US, UK, AU, FR … κλπ. |
| String | Ορισμένη διεύθυνση ηλεκτρονικού ταχυδρομείου επαφής για την τράπεζα ή το υποκατάστημα | |
| fax | String | Αριθμός Fax της τράπεζας/υποκαταστήματος |
| phone | String | Τηλεφωνικός αριθμός επικοινωνίας της τράπεζας/υποκαταστήματος |
| πολιτεία | String | Πολιτεία της διεύθυνσης της τράπεζας/υποκαταστήματος |
| ιστότοπος | String | Διεύθυνση ιστότοπου της τράπεζας/υποκαταστήματος |
| ταχυδρομικός κωδικός | String | Ταχυδρομικός κωδικός της διεύθυνσης της τράπεζας/υποκαταστήματος |
Ένα παράδειγμα απάντησης XML από το API για μια αναζήτηση κωδικού ταξινόμησης του Ηνωμένου Βασιλείου και ενός αριθμού λογαριασμού θα είναι:
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>
Η απάντηση για το ίδιο ερώτημα αν ο χρήστης καθορίσει μια μορφοποίηση JSON θα είναι:
"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
Σε περίπτωση σφάλματος, το API Υπολογισμού IBAN επιστρέφει μια απάντηση σε μορφή XML ή JSON που περιέχει το μήνυμα σφάλματος.Οι <error></error> ετικέτες XML επιστρέφονται χώρις κανένα άλλο πεδίο στην απάντηση XML.
Παρακάτω μπορείτε να βρείτε μια περιγραφή όλων των πιθανών μηνυμάτων σφάλματος που θα μπορούσαν να επιστραφούν:
<error>Ο έλεγχος αθροίσματος του αριθμού λογαριασμού δεν είναι έγκυρος.</error>
<error>Ο Αριθμός Λογαριασμού (έλεγχος αθροίσματος) δεν είναι σωστός.</error>
<error>Ο Αριθμός Λογαριασμού πρέπει να έχει μήκος 11 χαρακτήρες</error>
<error>Ο Αριθμός Λογαριασμού πρέπει να έχει μήκος 14 χαρακτήρες</error>
<error>Ο Αριθμός Λογαριασμού πρέπει να έχει μήκος 24 χαρακτήρες</error>
<error>Ο Αριθμός Λογαριασμού δεν είναι έγκυρος</error>
<error>Ο Αριθμός Λογαριασμού ή ο Κωδικός Ταξινόμησης δεν είναι έγκυρος</error>
<error>Το πρόθεμα του Αριθμού Λογαριασμού είναι πολύ μεγάλο.</error>
<error>Ο Αριθμός Λογαριασμού είναι πολύ μεγάλοςg.</error>
<error>Ο Κωδικός/ KIB (έλεγχος αθροίσματος) Τράπεζας/υποκαταστήματος δεν είναι σωστός.</error>
<error>Ο Κωδικός Τράπεζας / Κωδικός Υποκαταστήματος / Αριθμός Λογαριασμού είναι πολύ μεγάλος.</error>
<error>Ο Κωδικός Τράπεζας / Κωδικός Υποκαταστήματος (έλεγχος ψηφίων) δεν είναι σωστός.</error>
<error>Ο Τραπεζικός Κωδικός δεν είναι έγκυρος</error>
<error>Ο Τραπεζικός Κωδικός είναι πολύ μεγάλος.</error>
<error>Η Τράπεζα Δε Βρέθηκε</error>
<error>Η Τράπεζα Δεν Αναγνωρίζεται</error>
<error>Το BBAN / NIB (έλεγχος ψηφίων) δεν είναι σωστός.</error>
<error>Το BLZ/Κωδικός Τράπεζας δεν είναι έγκυρος</error>
<error>Το Υποκατάστημα/Πρακτορείο δε βρέθηκε</error>
<error>Ο Κωδικός Υποκαταστήματος είναι πολύ μεγάλος.</error>
<error>Το Υποκατάστημα δε βρέθηκε</error>
<error>Ο Έλεγχος Ψηφίου είναι πολύ μεγάλος.</error>
<error>Το Clearingnummer/Αριθμός Λογαριασμού δεν είναι έγκυρο. Ο έλεγχος ψηφίου είναι εσφαλμένος.</error>
<error>Το Clearingnummer / Κωδικός Τράπεζας δεν μπορεί να ταυτοποιηθεί. Το IBAN δεν μπορεί να υπολογιστεί.</error>
<error>Το Clearingnummer ή ο Αριθμός Λογαριασμού είναι πολύ μεγάλος.</error>
<error>Ο Κωδικός ABI της Τράπεζας/Κωδικός Τράπεζας δεν είναι έγκυρος</error>
<error>Ο Κωδικός CAB του Υποκαταστήματος/Κωδικός Υποκαταστήματος δεν είναι έγκυρος</error>
<error>Ο Κωδικός χώρας δεν είναι έγκυρος</error>
<error>Η Χώρα ή η Τράπεζα δεν υποστηρίζεται</error>
<error>Το IBAN δεν είναι έγκυρο</error>
<error>Το Kontonummer/Αριθμός Λογαριασμού δεν είναι έγκυρος</error>
<error>Λείπου πεδία</error>
<error>Μη FR IBAN</error>
<error>Μη FR IBAN χώρας</error>
<error>Λείπει ένα υποχρεωτικό πεδίο. Παρακαλούμε εισάγετε τον Κωδικό Τράπεζας και τον Αριθμό Λογαριασμού</error>
<error>Κάποια υποχρεωτικά πεδία δεν έχουν υποβληθεί.</error>
<error>Το RIB δεν είναι έκγυρο</error>
<error>Ο Κωδικός Ταξινόμησης / Κωδικός Τράπεζας δεν μπορεί να ταυτοποιηθεί. Το IBAN δεν μπορεί να υπολογιστεί.</error>
<error>Ο Κωδικός Ταξινόμησης δεν μπορεί να βρεθεί</error>