Інформація про опис функціоналу спеціалізованих інтерфейсів на порталі UPC за посиланням.

Основні параметри маршруту для всіх викликів до маршрутів API:

/providers/{provider-id}/{service}/{apiGroupVersion}/...

provider-id: завжди має значення 328209 — МФО банку «Південний».

Версія АPI, яку підтримує банк «Південний» - v2.2.0

PSU-ідентифікатори що мають використовуватись в запитах до банку «Південний»:

  • для визначення клієнтів фізичних осіб у POST - запитах, що стосуються доступу до рахунків, необхідно передавати одну з обов’язкових наступних комбінацій:

PSU-ID-Type тип ідентифікатора: string розміщення: header

PSU-ID тип ідентифікатора: string

розміщення: header

IBAN

UAxxxxxxxxxxxxxxxxxxxxxxxxxxx (29 символів)

PHONE

+380XXXXXXXXX (складається з коду країни (+380), коду мобільного оператора (2 цифри) та абонентського номера (7 цифр))

  • для визначення клієнтів – суб’єктів господарювання у POST - запитах, що стосуються доступу до рахунку юридичної особи/ФОП, необхідно передавати одну з обов’язкових наступних комбінацій:

PSU-Corporate-ID-Type

тип ідентифікатора: string

розміщення: header

PSU-Corporate-ID

тип ідентифікатора: string

розміщення: header

IBAN

UAxxxxxxxxxxxxxxxxxxxxxxxxxxx (29 символів)

TAXCODE

ЄДРПОУ (для юросіб): 8 цифр

TAXCODE

РНОКПП (для ФОП): 10 цифр

Запити, які будуть отримані без зазначених ідентифікаторів, або з даними які не відповідають опису — не будуть оброблюватись та будуть відхилятися з помилкою.

AIS (Account Information Service) — Сервіс надання інформації про рахунок

Сервіс надання інформації про рахунок (AIS) дозволяє TPP отримувати доступ до інформації про рахунок PSU.

Для доступу до інформації TPP повинен спочатку отримати авторизацію (підтвердження згоди) від PSU. Підтвердження PSU згоди відбувається  в застосунку банка «Південного» із застосуванням посиленої аутентифікації  (SCA).

Для проходження SCA використовуються наступні застосунки банку:

  • Для PSU -фізичної особи: – мобільний застосунок «Pivdenny Online»;
  • Для PSU -представника суб’єктів господарювання - веб застосунок – «WEB iFobs new».

У разі відсутності активного застосунку – доступи до рахунків в системі відкритого банкінгу не надаються.

На підставі підтвердженої згоди TPP може отримувати інформацію про рахунки PSU: залишки, історію транзакцій та інші відповідні дані.

Банк «Південний» підтримує надання інформації за рахунками (маски та типи рахунків):

Маска рахунку

Тип рахунку

Позначення типу рахунку за форматом ISO20022

 2620%*

«Кошти на вимогу фізичних осіб»

CACC

CARD

2621%

«Кошти на вимогу суб'єктів незалежної професійної діяльності»

CACC

2650%

«Кошти на вимогу небанківських фінансових установ»

CACC

2600%

«Кошти на вимогу суб’єктів господарювання»

CARD

CACC

2604%

«Цільові кошти на вимогу суб’єктів господарювання»

CACC

* За виключенням депозитів, які обліковуються на балансових рахунках 2620%.

Валюта рахунку: валюта рахунку відповідно до Класифікатору іноземних валют та банківських металів, які відображаються у застосунку Банку «Південний». 

Банк «Південний» підтримує роботу з мультивалютними рахунками.

Основні функції інтерфейсу AIS:

1. Створення згоди на доступ до рахунку:

TPP надсилає запит на створення згоди методом POST /ais/v2/consents/account-access.

У запиті передаються:

  • IBAN рахунку;
  • права доступу ("accountDetails", "balances", "transactions");
  • тип згоди;
  • ознака повторюваного доступу (recurringIndicator);
  • строк дії (validTo);
  • максимальна частота запитів на день (frequencyPerDay, максимум 4 рази на добу).

У відповідь на запит повертається унікальний ідентифікатор згоди (consentId).

Особливості AIS згоди:

  • Термін дії Згоди (validTo) не може перевищувати 90 календарних днів, включно з днем надання згоди;
  • Згода доступна до підтвердження PSU протягом терміну дії Згоди;
  • Згода втрачає чинність достроково, якщо вона була відкликана будь-яким учасником згоди (PSU, TPP, банком «Південним») у будь-який час протягом дії цієї згоди;
  • Якщо у запиті на створення Згоди «recurringIndicator» дорівнює true і у цього PSU для цього TPP і рахунку вже існує діюча багаторазова Згода, тоді попередня згода автоматично втрачає чинність, як тільки нова Згода буде успішно авторизована PSU;
  • Якщо у request  на створення Згоди "recurringIndicator" дорівнює false і у цього PSU для цього TPP і рахунку існує діюча багаторазова Згода, то припинення дії попередньої Згоди не відбувається (разова Згода не призводить до втрати чинності багаторазової згоди).

Особливості створення згоди за мультивалютними рахунками:

  • Якщо у запиті на створення Згоди на отримання відомостей з мультивалютного рахунку не вказана валюта - то Згода надається на усі валюти мультивалютного рахунку;
  • Якщо у запиті на створення Згоди на отримання інформації по мультивалютному рахунку вказана валюта - то згода надається лише на доступ до мультивалютного рахунку з вказаною валютою.

Типи згоди, які підтримує банк «Південний»:  

Тип згоди

Особливості

«detailed»

Банк «Південний» підтримує обробку згоди, котра може містити один або декілька рахунків одночасно

«accountList»

Запит повинен містити атрибути «доступу» до рахунку/рахунків «accounts», «balances», «transactions»). Запит буде відхилено, якщо він не містить жодного атрибуту «доступу».

Звертаємо увагу на те, що після авторизації згоди PSU, відбувається оновлення даних згоди даними, які PSU підтвердив в застосунку АБ «Південного», а саме:

·        До згоди додається перелік рахунків та прав доступу до них, які було підтверджено PSU,

·        Актуалізація типу згоди - на «detailed». 

2. Авторизація згоди (SCA):

Після створення згоди TPP ініціює авторизацію через метод POST /ais/v2/consents/account-access/{consent-id}/authorisations.

Підтримується режим SCA:

  • Decoupled SCA: платформа повертає повідомлення для PSU (psuMessage), наприклад, "Авторизуйте згоду у мобільному застосунку банку". PSU авторизує згоду безпосередньо у застосунку банку (через push-сповіщення).

TPP перевіряє статус згоди методом GET /ais/v2/consents/account-access/{consent-id}/status до отримання статусу "valid" або "rejected".

3. Отримання переліку рахунків:

TPP отримує перелік рахунків PSU методом GET /ais/v2/accounts?withBalance=true, передаючи заголовок Consent-ID з ідентифікатором підтвердженої згоди. У відповідь повертається список рахунків із IBAN, валютою, ідентифікатором ресурсу, назвою рахунку та поточними балансами (за потреби).

4. Отримання історії транзакцій:

TPP отримує історію транзакцій за рахунком методом GET /ais/v2/accounts/{account-id}/transactions.

Банк надає історію транзакцій за останні 31 день.

PIS (Payment Initiation Service) — Сервіс ініціювання платежів

Сервіс ініціювання платежів (PIS) дозволяє TPP ініціювати платежі від імені користувача PSU. Для ініціювання платежу PSU надає свою згоду в застосунку банка «Південного». Підтвердження PSU згоди відбувається с застосуванням посиленої аутентифікації  (SCA) в застосунку банка «Південний».

Для проходження SCA використовуються наступні застосунки банку:

  • Для PSU -фізичної особи: – мобільний застосунок «Pivdenny Online»;
  • Для PSU -представника суб’єктів господарювання - веб-застосунок «WEB iFobs new».

У разі відсутності активного застосунку – доступи до рахунків в системі відкритого банкінгу не надаються.

Особливості PIS сервісів:

  • Ініціація платежу відбувається лише з рахунків та на рахунки відкриті в банках України;
  • Ініціація платежу можлива лише в національній валюті та з рахунку/на рахунок відкритому в національній валюті;
  • Платіж після підтвердження згоди з боку PSU — є безвідкличним.

Типи платіжного продукту (payment-product) що можуть бути обрані PSU:

  • «Миттєвий кредитовий грошовий перекази в межах України» в національній валюті (instant-credit-transfers);
  • «Звичайний кредитовий грошовий переказ в межах України» в національній валюті (credit-transfers).

Запити на ініціювання платежу, які були отримані в момент закриття операційного дня або з невалідними даними — будуть відхилятися з помилкою.

Ліміти для ініціювання платіжних операцій

  • Для «Миттєвий кредитовий грошовий перекази в межах України» — максимально дозволена сума — 100 000,00 грн.;
  • Для «Звичайний кредитовий грошовий переказ в межах України» — максимально дозволена сума — 99 999,99 грн.
  • Якщо у клієнта встановлений індивідуальний ліміт, то в рамках індивідуального ліміту максимальна дозволена сума не має бути перевищена.

Банк «Південний» використовує наступні статуси платежів:

Код статусу

Розшифровка (ISO 20022)

Тип статусу

Опис та застосування

RCVD

Received

Початковий

Встановлюється при створенні платіжної операції.

PDNG

Pending

Проміжний

Встановлюється, коли одного з фінальних статусів платіжної операції ще не досягнуто.

ACSC

Accepted Settlement Completed Debitor Account

Фінальний

Встановлюється для звичайного кредитового переказу, коли кошти списані з рахунку платника.

ACCC

AcceptedSettlementCompleted

Фінальний

Встановлюється для миттєвого кредитового переказу, коли кошти списані з рахунку платника.

RJCT

Rejected

Фінальний

Встановлюється, якщо платіж відхилено.

 

Основні функції інтерфейсу PIS

1. Ініціювання платежу

TPP надсилає запит на ініціювання платежу за допомогою методу POST /pis/v2/payments/{payment-product}.

У запиті передаються дані про рахунок платника (IBAN), суму та валюту переказу, дані отримувача (ім'я, ідентифікатор, IBAN рахунку) та реквізити призначення платежу. У відповідь на запит повертається унікальний ідентифікатор транзакції (paymentId) та початковий статус платежу (RCVD — отримано).

2. Запуск авторизації (SCA)

Після ініціювання платежу TPP викликає метод POST /pis/v2/payments/{payment-product}/{payment-id}/authorisations для явного запуску процедури авторизації. Підтримується режим SCA:

  • Decoupled SCA: платформа повертає повідомлення для PSU (psuMessage), наприклад, "Авторизуйте платіж у мобільному застосунку банку". PSU авторизує платіж безпосередньо у застосунку банку (через push-сповіщення).

3. Перевірка статусу платежу

    TPP може перевірити поточний статус платежу за допомогою методу GET /pis/v2/payments/{payment-product}/{payment-id}/status. У відповідь на запит повертається актуальний статус транзакції (transactionStatus), наприклад, ACCC (успішно завершено).