API Перевірки BIC / SWIFT Коду

Як інтегрувати API Перевірки BIC у ваше програмне забезпечення

1. Що таке API Перевірки BIC?

Під час обробки електронних переказів і маючи справу з транзакціями, пов'язаними з IBAN, надзвичайно важливим для успішних платежів є надання правильного SWIFT / BIC коду.
Наша компанія має ліцензію на офіційний Каталог BIC від S.W.I.F.T SCRL, щоб забезпечувати потужний та простий спосіб автоматичної перевірки BIC. Ця послуга дозволяє вам інтегрувати пошук за каталогом BIC кодів у ваше програмне забезпечення для внутрішніх потреб

API Перевірки BIC коду має SWIFTRef дані всередині. Дані BIC використовуються з дозволу S.W.I.F.T. SCRL. Права на базу даних захищені 2019

2. Особливості

Основні особливості API Перевірки BIC:

  • Отримання інформації про банк на основі BIC коду.
  • Пошук по BIC каталогу за частиною назви банку та країни.
  • Пошук по BIC каталогу для історичних записів.
  • Використання як повної, так і спрощенної API відповіді для простішої інтеграції.


3. Використання API

API Перевірки BIC засновується на функції REST та підтримує прості HTTP GET або POST запити.

Прийняті параметри наведено в таблиці нижче:

Назва поля Довжина Вид Опис
bic 11 Рядок BIC / SWIFT код для пошуку. Може мати 8 або 11 символів
назва_банку 256 Рядок Частина назви банку для виконання пошуку у каталозі BIC.
країна 2 Рядок Дві літери коду країни. Вимагається при пошуку за назвою банку.
api_ключ 128 Рядок Ваш персональний ключ API.
формат 4 Рядок Вимагається для специфікації формату даних, що виводяться. На даний час підтримуються значення: json, xml
ліміт Ціле число Необов'язково: може використовуватись для обмеження числа результатів при пошуку за назвою банку.
hist Ціле число Необов'язково: може використовуватись для відображення історичних записів з бази даних, як для пошуку банку, так і для пошуку BIC коду.
Всередині вашого Онлайн Порталу ви можете знайти ваш API ключ та зробити Запит на кінцевий URL, який використовується для захисту пошукових запитів.


4. XML Структура Відповіді API

Ви можете завантажити XSD Схему API відповіді.
Детальний опис полів, що виводяться, відображено у таблиці нижче:

Назва поля Вид Довжина Завжди присутній Опис
ЗНАЧОК МОДИФІКАЦІЇ Алфавітний 1 Так В дельта файлах:
• A (додавання)
• M (модифікація)
• D (видалення) в повних файлах В повних файлах:
• A (додавання)
ЗМІНЕНІ ПОЛЯ Числовий 186 Ні Записує поле (або TAG), яке було змінено або в результаті зміни запису, або як результат нової ПОДІЇ.
Один або більше стовпців позначено як послідовність чисел, де кожне число представляє стовпець, що було змінено від попереднього запису або попередньої ПОДИЇ.
Наприклад "6,7,8,9"
Це означає, що EVENT TYPE, EVENT DATE, BIC8, та BRANCH BIC було
змінено.
Наступні ПОЛЯ віключено із записів ЗМІНЕНОГО ПОЛЯ:
• КЛЮЧ ЗАПИСУ
• ЗМІНЕНЕ ПОЛЕ
• ЗНАЧОК МОДИФІКАЦІЇ
КЛЮЧ ЗАПИСУ Буквено-числовий 12 Так Унікальний ключ запису у файлі
Кожен запис представляє подію у життєвому циклі BIC.
Після призначення КЛЮЧ ЗАПИСУ ніколи не змінюється.
ПОПЕРЕДНІЙ КЛЮЧ ЗАПИСУ Буквено-числовий 12 Ні КЛЮЧ ЗАПИСУ раніше пов'язаної ПОДІЇ
Всі пов'язані події пов'язані між собою і можуть бути розміщені за допомогою цієї інформації.
НАСТУПНИЙ КЛЮЧ ЗАПИСУ Буквено-числовий 12 Ні КЛЮЧ ЗАПИСУ наступної пов'язаної ПОДІЇ
Всі пов'язані події пов'язані між собою і можуть бути розміщені за допомогою цієї інформації.
ВИД ПОДІЇ Алфавітний 32 Так ПОДІЯ або опис зміни, пов'язаної з BIC, які відбувалися в минулому, відбуваються зараз, або будуть відбуватися у майбутньому.
Види Подій:
• BIC ВИДАНО
• BIC СПЛИВ
• BIC АКТИВОВАНО НА FIN
• BIC АКТИВОВАНО НА FA
• BIC АКТИВОВАНО НА IA
• BIC ДЕАКТИВОВАНО НА FIN
• BIC ДЕАКТИВОВАНО НА FA
• BIC ДЕАКТИВОВАНО НА IA
• BIC ДЕАКТИВОВАНО
• BIC ПРИПИНЕНО
• BIC ВІДНОВЛЕНО
• BIC ОПУБЛІКОВАНО
• BIC ПРАВОВУ НАЗВУ ЗМІНЕНО
• BIC НАЗВУ УСТАНОВИ ЗМІНЕНО
• BIC АДРЕСУ ЗМІНЕНО
• FIN СЕРВІСНИЙ КОД ЗМІНЕНО
Остання дата оновлення - це останній рядок послідосності BIC (тобто, останній запис).
Коли додається нова ПОДІЯ, ЗНАЧОК МОДИФІКАЦІЇ та стовпець ЗМІНЕНОГО
ПОЛЯ буде оновлено безпосередньо у попередній ПОДІЇ.
ДАТА ПОДІЇ Буквено-числовий 8 Так Дата ПОДІЇ
BIC8 Буквено-числовий 8 Так BIC (установа, країна, та суфікс компанії), де:
• Префікс компанії (4 символи)
• Код країни (2 символи)
• Суфікс компанії (2 символи)
ВІДДІЛЕННЯ BIC Буквено-числовий 3 Так Ідентифікатор відділення BIC пов пов'язаний з 8-значним BIC. Якщо не існує ідентифікатора відділення, тоді використовується XXX.
BIC Буквено-числовий 11 Так Повний BIC: 8-значний BIC та ідентифікатор відділення
СТАТУС ЗАПИСУ Алфавітний 1 Так Визначає статус запису:
• [C] = Поточний, представляє останню подію в ланцюжку до останньої дати публікації, окрім [F] - майбутніх подій
• [H] = Історичні записи в ланцюжку подій
• [F] = Майбутня подія, яка відбудеться після дати публікациї каталогу. Попередньо визначена [C] - Поточна подія, буде дійсною, поки не настане дата, зазначена у [F] - майбутній події.
Для МАЙБУТНІХ подій, дата визначає, ВІДКОЛИ зміни стануть ДІЙСНИМИ.
ОПЕРАЦІЙНО АКТИВНИЙ ЗАПИС Алфавітний 1 Так Є кілька записів для одного і того ж BIC. Це поле вказує, який з записів для одного і того ж BIC є операційно активним BIC і повинен використовуватися.
• [Y] Операційно активний
• [N] Операційно неактивний
Для кожного унікального BIC існує єдиний запис, що вказує на АКТИВНИЙ статус (Y).
Записи з [H] - Історичним статусом завжди будуть позначени як [N].
Записи з [C] - Поточні, можуть позначатися як [Y] або [N].
Записи з [F] завжди позначатимуться як [N].
ІНДИКАТОР ПІДТИПУ Будь-який вид 4 Так Тип бізнесу підприємства. Індикатор підтипу надається лише для записів з BIC.
SWIFT FIN Алфавітний 1 Так Статус підключення суб'єкта до FIN:
• [Y] підключено до FIN
• [N] не підключено до FIN
SWIFT FA Алфавітний 1 Так Статус доступності суб'єкта через FileAct:
• [Y] підключено до FileAct
• [N] не підключено до FileAct
SWIFT IA Алфавітний 1 Так Статус досяжності суб'єкта через InterAct:
• [Y] підключено до InterAct
• [N] не підключено до InterAct
ПРАВОВА НАЗВА Будь-який 105 Ні Правова назва установи
НАЗВА УСТАНОВИ Будь-який 105 Так Торгова назва установи (опублікована назва)
ВИД УСТАНОВИ Алфавітний 12 Так Організація, яка в основному займається фінансовим посередництвом та / або допоміжною фінансовою діяльністю
Вид установи:
• ФІНАНСОВА
• НЕФІНАНСОВА
ВИД ОБ'ЄКТА Алфавітний 16 Так Визначає тип фінансового об'єкту:
• Правовий об'єкт
• Відділення
• Операційний
АДРЕСА ВУЛИЦІ РЕЄСТРАЦІЇ 1 Будь-який 35 Ні [Реєстрація] Назва вулиці
АДРЕСА ВУЛИЦІ РЕЄСТРАЦІЇ 2 Будь-який 35 Ні [Реєстрація] Номер вулиці
АДРЕСА ВУЛИЦІ РЕЄСТРАЦІЇ 3 Будь-який 35 Ні [Реєстрація] Будинок, назва будинку, поверх
АДРЕСА ВУЛИЦІ РЕЄСТРАЦІЇ 4 Будь-який 35 Ні [Реєстрація] Район
МІСТО РЕЄСТРАЦІЇ Будь-який 35 Ні [Реєстрація] Назва міста установи/відділення
РЕГІОН РЕЄСТРАЦІЇ Будь-який 90 Ні [Реєстрація] Округ, область, штат, або інший адміністративний регіон власника установи/відділення
РЕЄСТРАЦІЙНИЙ ПОШТОВИЙ ІНДЕКС Будь-який 15 Ні [Реєстрація] Індекс установи/відділення
РЕЄСТРАЦІЙНИЙ POB НОМЕР Будь-який 35 Ні Поле, розділене комами, з номером POB установи/відділення та відповідним поштовим індексом.
Наприклад
"POB 103352, 40024"
Це дозволяє клієнтам використовувати повну адресу POB:
POB 103352
40024, DUESSELDORF (CITY)
ОПЕРАЦІЙНА АДРЕСА ВУЛИЦІ 1 Будь-який 35 Ні [Операційна] Назва вулиці
ОПЕРАЦІЙНА АДРЕСА ВУЛИЦІ 2 Будь-який 35 Ні [Операційний] Номер вулиці
ОПЕРАЦІЙНА АДРЕСА ВУЛИЦІ 3 Будь-який 35 Ні [Операційний] Будинок, назва будинку, поверх
ОПЕРАЦІЙНА АДРЕСА ВУЛИЦІ 4 Будь-який 35 Ні [Операційна] Район
ОПЕРАЦІЙНЕ МІСТО Будь-який 35 Ні [[Операційне] Місто установи/відділення
ОПЕРАЦІЙНИЙ РЕГІОН Будь-який 90 Ні [Операційний] Округ, область, штат, або інший адміністративний регіон власника установи/відділення
ОПЕРАЦІЙНИЙ ПОШТОВИЙ ІНДЕКС Будь-який 15 Ні [Операційний] Поштовий індекс установи/відділення<
ОПЕРАЦІЙНИЙ POB НОМЕР Будь-який 35 Ні Поле, розділене комами, з номером POB установи/відділення та відповідним поштовим індексом.
Наприклад
"POB 103352, 40024"
Це дозволяє клієнтам використовувати повну адресу POB:
POB 103352
40024, DUESSELDORF (CITY)
АДРЕСА ВУЛИЦІ ВІДДІЛЕННЯ 1 Будь-який 35 Ні [Відділення] Назва вулиці
АДРЕСА ВУЛИЦІ ВІДДІЛЕННЯ 2 Будь-який 35 Ні [Відділення] Номер вулиці
АДРЕСА ВУЛИЦІ ВІДДІЛЕННЯ 3 Будь-який 35 Ні [Відділення] Будинок, назва будинку, поверх
АДРЕСА ВУЛИЦІ ВІДДІЛЕННЯ 4 Будь-який 35 Ні [Відділення] Район
МІСТО ВІДДІЛЕННЯ Будь-який 35 Ні [Відділення] Назва міста установи/відділення
РЕГІОН ВІДДІЛЕННЯ Будь-який 90 Ні [Відділення] Округ, область, штат, або інший адміністративний регіон власника установи/відділення
ПОШТОВИЙ ІНДЕКС ВІДДІЛЕННЯ Будь-який 15 Ні [Branch] Поштовий індекс установи/відділення
POB НОМЕР ВІДДІЛЕННЯ Будь-який 35 Ні Поле, розділене комами, з номером POB установи/відділення та відповідним поштовим індексом.
Наприклад
"POB 103352, 40024"
Це дозволяє клієнтам використовувати повну адресу POB:
POB 103352
40024, DUESSELDORF (CITY)
ІНФОРМАЦІЯ ПРО ВІДДІЛЕННЯ Будь-який 70 Ні Інформація про відділення
Це безкоштовний текстовий опис відділення, що надається фінансовою установою, до якої воно належить. Наразі цю інформацію буде надано лише для записів з BIC і тільки тоді, коли відповідна фінансова установа захоче надати цю додаткову інформацію. Інформація походить з каталогу BIC.
НАЗВА КРАЇНИ Будь-який 70 Так Назва країни установи/відділення як зазначено у ISO 3166
ISO КОД КРАЇНИ Алфавітний 2 Так ISO 3166-1 2-літерний код країни установи/відділення
КОД ЛОКАЦІЇ Будь-який вид 1 Так Містить локацію (формально на 7-й позиції BIC стандарту:2009)
Наприклад:
• У FR, BIC у Парижі = P
• У BE, BIC у Брюсселі = B
• У US, BIC на Східному Узбережжі = 3
КОДИ ПОСЛУГ FIN Будь-який вид 60 Ні Коди послуг FIN (також називаються кодами послуг з доданою вартістю). Коди послуг надаються тільки для записів, що містять BIC.
Поле може містити до 20 трисимвольних кодів в алфавітному порядку.
КЛЮЧ ЗАПИСУ BDP Буквено-числовий 12 Ні Унікальний ключ запису Каталогу Банку Плюс (Bank Directory Plus) у файлі.
ПОЛЕ A Будь-який 1 Ні Збережено для майбутнього використання
ПОЛЕ B Будь-який 64 Ні Збережено для майбутнього використання
ПОЛЕ C Будь-який 128 Ні Збережено для майбутнього використання
ПОЛЕ D Будь-який 256 Ні Збережено для майбутнього використання
ПОЛЕ E Будь-який 11 Ні Збережено для майбутнього використання
ПОЛЕ F Будь-який 12 Ні Збережено для майбутнього використання
Система API повертає результати у форматі XML, який легко розбирається на різних мовах і платформах програмування.

Зразок XML-відповіді від API для пошуку BIC:


<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

У разі помилки API повертає XML-відповідь, що містить повідомлення про помилку.

Теги XML повертаються без будь-яких інших полів у відповіді XML.

Нижче наведено опис усіх можливих повідомлень про помилки, які можна вивести:

Код статусу Вид Опис
301 Помилка облікового запису Ключ API недійсний
302 Помилка облікового запису Термін дії підписки закінчився
303 Помилка облікового запису Немає доступних запитів
304 Помилка облікового запису Ви не маєте доступу до цього API
401 Помилка введення Допускається SWIFT довжиною 8 або 11 символів'
402 Помилка введення Назва банку недійсна! Пошук банку повинен складатися не менше ніж з 4 символів.
Дозволені символи a-z, A-Z, 0-9, [пробіл]!
403 Помилка введення Код країни неправильний! Дозволений код країни з 2 літер. Наприклад: UK, DE, FR