openapi: 3.0.3 info: title: API для користувачів Openbanking description: "API відкритого банкінгу створено на основі специфікації Open API Group
Всі запити виконуються по протоколу OAuth2. Для цього необхідно засобами API отримати токен. В сеедовищі swagger натиснути кнопку Authorizer і внести зчення токену
Згода про надання інформації по рахунку може бути разовою або багаторазовою. Згод по одному рахунку може бути декілька із різною специфікою
Згода має бути авторизована після створення. Авторизація згоди виконується з мобільному застосунку RB24.
В рамка API swagger надані IBAN для тестування:
UAH - UA453065000000026200500019048
USD - UA453065000000026200500019048
EUR - UA453065000000026200500019048
В разі виникнення питань, прохання звертатись на електронну адресу : support@radbank.com.ua
version: 1.0.0" servers: - url: https://OpenBanking.radabank.com.ua/gate_openbank/providers/1/api/v0 description: Local development server tags: - name: 1. Управління згодою #description: Управління згодою - name: 2. Отримання відомостей по рахункам згоди (баланс, виписка) #description: Інформація по згоді - name: 3. Управління платежами #description: Платежі paths: /openbank/token: post: parameters: # - name: Signature # in: header # description: an authorization header # required: true # type: string # default: "4a0f989d44d9f2f93835107a2d9c646b8926b55368441b9069f3aaf71817e047" # - name: Signdate # in: header # description: an authorization header # required: true # type: string # default: "2025.07.11" - name: X-Request-ID in: header description: Request Identification required: true type: UUID default: "6f2be15d-a073-4652-8d9b-f7167c607bcf" # - name: Access-Control-Allow-Origin # in: header # description: an authorization header # required: true # type: string # default: "https://vOpenBanking.radabank.com.ua" summary: Запит на отримання токену requestBody: required: true content: application/json: schema: type: object required: - client_id - client_secret properties: client_id: type: UUID example: 6f2be15d-a073-4652-8d9b-f7167c607bcf client_secret: type: string example: I1OXRIkVwSSvEbd8HQh5aDCYCCLqtYqr responses: '202': description: OK schema: type: object properties: now: type: object properties: rfc2822: type: string /consents/account-access: post: tags: - 1. Управління згодою # Привязка к глобальному тегу summary: Створення згоди parameters: - name: Content-Type in: header description: Тип контенту, що передається мережею Інтернет по протоколу HTTP required: true type: string default: "application/json" - name: X-Request-ID in: header description: Унікальний ідентифікатор запиту згенерований стороною-ініціатором required: true type: UUID - name: PSU-IP-Address in: header description: IP адреса, з якої власник рахунку ініціює запит required: true type: string default: "192.168.0.0" - name: PSU-ID-Type in: header description: Тип ідентифікатора власника рахунку (наразі це IBAN, в подальшому можливі варіанти "телефон", "ІПН" ) required: true schema: type: string enum: [IBAN]#, phone-late, INN-late] default: "IBAN" - name: PSU-ID in: header description: Значення ідентифікатору клієнта в банку (IBAN) required: true type: string default: "UA453065000000026200700028937" security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object required: - access - consentType - frequencyPerDay - recurringIndicator - validTo properties: access: title: Тип даних, що будуть запитуваться (деталі рахунку, баланс, виписка, назва власника) type: array items: type: string default: ["accountDetails", "balances", "transactions", "ownerName"] consentType: title: Тип згоди type: string default: "detailed" recurringIndicator: title: Ознака багаторазового доступу до даниих по згоді type: boolean default: true frequencyPerDay: title: Кількість запитів на день зі сторони третьої особи (не власника рахунків) (max 4) type: string default: "4" validTo: title: Дата закінчення терміну дії згоди (термін дії не більше 180 днів) pattern: "yyyy-MM-dd" type: string default: "2025-04-30" responses: '202': description: OK schema: hidden: true type: object properties: now: type: object properties: rfc2822: type: string '201': description: Згоду створено headers: Location: description: Розташування створеного ресурсу required: true style: simple schema: type: string example: /v2/consents/account-access/e89f3796-fc51-4c1a-89fd-3f21b0367efd X-Request-ID: description: Унікальний ідентифікатор запиту згенерований стороною-ініціатором required: true schema: type: string example: cae7fa99-80b6-4eb3-88c1-0f5004ae3e13 ASPSP-SCA-Approach: description: Спосіб авторизації клієнта на стороні банку required: true schema: type: string example: DECOUPLED content: application/json: schema: type: object required: - consentStatus - consentId - _links - psuMessage properties: consentStatus: description: Статус згоди type: string example: received consentId: description: Ідентифікатор згоди type: string example: e89f3796-fc51-4c1a-89fd-3f21b0367efd _links: description: Посилання на авторизацію і статус згоди type: object properties: startAuthorisationWithPsuIdentification: type: string title: посилання example: /v2/consents/account-access/e89f3796-fc51-4c1a-89fd-3f21b0367efd/authorizations status: type: string title: посилання example: /v2/consents/account-access/e89f3796-fc51-4c1a-89fd-3f21b0367efd/status psuMessage: type: string example: Авторизуйте згоду '400': description: Помилковий запит content: application/json: schema: $ref: '#/components/schemas/ErrorMessage4__' '401': description: Запит не авторизован content: application/json: schema: $ref: '#/components/schemas/ErrorMessage4__' '500': description: Внутрішня помилка серверу /consents/account-access/{consentID}/status: get: tags: - 1. Управління згодою # Привязка к глобальному тегу summary: Отримати статус згоди parameters: - name: consentID in: path description: Ідентифікатор згоди required: true type: string - name: X-Request-ID in: header description: Унікальний ідентифікатор запиту згенерований стороною-ініціатором required: true type: UUID security: - bearerAuth: [] responses: '202': description: OK schema: type: object properties: now: type: object properties: rfc2822: type: string '200': description: Статус згоди надано headers: X-Request-ID: description: Унікальний ідентифікатор запиту згенерований стороною-ініціатором required: true schema: type: string example: cae7fa99-80b6-4eb3-88c1-0f5004ae3e13 content: application/json: schema: type: object required: - consentStatus - psuMessage properties: consentStatus: description: Статус згоди type: string example: received psuMessage: description: Повідомлення користувачу type: string example: Для більш детальної інформації перейдіть за посиланням ..... '400': description: Помилковий запит content: application/json: schema: $ref: '#/components/schemas/ErrorMessage4__' '401': description: Запит не авторизован content: application/json: schema: $ref: '#/components/schemas/ErrorMessage4__' '500': description: Внутрішня помилка серверу /consents/account-access/{consentID}: get: tags: - 1. Управління згодою # Привязка к глобальному тегу summary: Параметри згоди parameters: - name: consentID in: path description: Ідентифікатор згоди required: true type: string - name: X-Request-ID in: header description: Ідентифікатор запиту, унікальний для виклику, визначений стороною-ініціатором required: true type: UUID security: - bearerAuth: [] responses: '200': description: Параметри згоди надано headers: X-Request-ID: description: Унікальний ідентифікатор запиту згенерований стороною-ініціатором required: true schema: type: string example: cae7fa99-80b6-4eb3-88c1-0f5004ae3e13 content: application/json: schema: type: object required: - access - consentStatus - consentType - frequencyPerDay - recurringIndicator - validTo properties: access: title: Опис доступу type: object properties: payments: title: Платіжний тип type: array items: type: object properties: account: description: Рахунок type: object properties: iban: description: IBAN type: string example: UA413077700000026201021926557 currency: description: Валюта рахунку type: string example: "UAH" rights: description: Тип доступу type: array example: ["balances", "transactions", "accountDetails"] consentType: description: Тип згоди type: string example: "detailed" enum: ["detailed" ] recurringIndicator: description: Ознака багаторазового доступу до даних по згоді type: boolean example: true frequencyPerDay: description: Кількість запитів на день зі сторони третьої особи (не власника рахунків) (max 4) type: string example: "3" validTo: title: Дата закінчення терміну дії згоди (термін дії не більше 180 днів) pattern: "yyyy-MM-dd" type: string default: "2025-04-30" '202': description: OK schema: type: object properties: now: type: object properties: rfc2822: type: string '400': description: Помилковий запит content: application/json: schema: $ref: '#/components/schemas/ErrorMessage4__' '401': description: Запит не авторизован content: application/json: schema: $ref: '#/components/schemas/ErrorMessage4__' '500': description: Внутрішня помилка серверу /consents/account-access/{consentID}/authorizations: post: tags: - 1. Управління згодою # Привязка к глобальному тегу summary: Ініціювати процес авторизації згоди parameters: - name: consentID in: path description: Ідентифікатор згоди required: true type: string - name: X-Request-ID in: header description: Унікальний ідентифікатор запиту згенерований стороною-ініціатором required: true type: UUID - name: PSU-IP-Address in: header description: IP адреса, з якої власник рахунку ініціює запит required: true type: string default: "192.168.0.0" - name: PSU-ID in: header description: Значення ідентифікатору клієнта в банку (IBAN) required: true type: string default: "UA453065000000026200700028937" - name: PSU-ID-Type in: header description: Тип ідентифікатора власника рахунку (наразі це IBAN, в подальшому можливі варіанти "телефон", "ІПН" ) required: true type: string default: "UA453065000000026200700028937" - name: TPP-SCA-Approach-Preference in: header description: Список підходів до потоку, за бажаним приорітетом надавача послуг, після проходження авторизаації, required: true type: string default: "decoupled, redirect" - name: TPP-Redirect-URI in: header description: Адреса перенаправлення потоку після успішної аторизації required: true type: string default: "https://provider.app/consent/{consentID}/authorization/" - name: TPP-Nok-Redirect-URI in: header description: Адреса перенаправлення потоку після не вдалої аторизації required: true type: string default: "https://provider.app/consent/{consentID}/authorization/" security: - bearerAuth: [] responses: '201': description: Дані для авторизації згоди надано headers: X-Request-ID: description: Унікальний ідентифікатор запиту згенерований стороною-ініціатором required: true schema: type: string example: cae7fa99-80b6-4eb3-88c1-0f5004ae3e13 ASPSP-SCA-Approach: description: Спосіб авторизації клієнта з боку банку required: true schema: type: string example: DECOUPLED content: application/json: schema: type: object required: - scaStatus - authorisationId - _links - psuMessage properties: scaStatus: title: Статус авторизації згоди type: string example: started authorisationId: title: Унвкальний ідентифікатор процесу авторизації згоди type: string example: started _links: description: Посилання на авторизацію і статус згоди type: object properties: scaStatus: type: string title: посилання для отримання статусу авторизації example: "/v2/consents/account-access/e89f3796-fc51-4c1a-89fd-3f21b0367efd/authorizations/b89f1d06-fc51-4c1a-89fd-3f21b0367efd/status" psuMessage: description: Повідомлення користувачу type: string example: Для більш детальної інформації перейдіть за посиланням ..... '202': description: OK schema: type: object properties: now: type: object properties: rfc2822: type: string '400': description: Помилковий запит content: application/json: schema: $ref: '#/components/schemas/ErrorMessage4__' '401': description: Запит не авторизован content: application/json: schema: $ref: '#/components/schemas/ErrorMessage4__' '500': description: Внутрішня помилка серверу /consents/account-access/{consentID}/authorizations/{authorizationID}/status: get: tags: - 1. Управління згодою # Привязка к глобальному тегу summary: Запит статусу авторизації згоди parameters: - name: consentID in: path description: Ідентифікатор згоди required: true type: string - name: authorizationID in: path description: Ідентифікатор авторизації згоди required: true type: string - name: X-Request-ID in: header description: Унікальний ідентифікатор запиту згенерований стороною-ініціатором required: true type: UUID security: - bearerAuth: [] responses: '200': description: Статус авторизації згоди надано headers: X-Request-ID: description: Унікальний ідентифікатор запиту згенерований стороною-ініціатором required: true schema: type: string example: cae7fa99-80b6-4eb3-88c1-0f5004ae3e13 content: application/json: schema: type: object required: - scaStatus - psuMessage properties: consentStatus: description: Статус авторизації згоди type: string example: started psuMessage: description: Повідомлення користувачу type: string example: "Для авторизації згоди за посиланням ....." '202': description: OK schema: type: object properties: now: type: object properties: rfc2822: type: string '400': description: Помилковий запит content: application/json: schema: $ref: '#/components/schemas/ErrorMessage4__' '401': description: Запит не авторизован content: application/json: schema: $ref: '#/components/schemas/ErrorMessage4__' '500': description: Внутрішня помилка серверу /consents/account-access/{consentID}/deletebyprovider: delete: tags: - 1. Управління згодою # Привязка к глобальному тегу summary: Видалення згоди надавачем послуг parameters: - name: consentID in: path description: Ідентифікатор згоди required: true type: string - name: X-Request-ID in: header description: Унікальний ідентифікатор запиту згенерований стороною-ініціатором required: true type: UUID security: - bearerAuth: [] responses: '202': description: OK schema: type: object properties: now: type: object properties: rfc2822: type: string '204': description: Згоду видалено headers: X-Request-ID: description: Унікальний ідентифікатор запиту згенерований стороною-ініціатором required: true schema: type: string example: cae7fa99-80b6-4eb3-88c1-0f5004ae3e13 '400': description: Помилковий запит content: application/json: schema: $ref: '#/components/schemas/ErrorMessage4__' '401': description: Запит не авторизован content: application/json: schema: $ref: '#/components/schemas/ErrorMessage4__' '500': description: Внутрішня помилка серверу /consents/account-access/{consentID}/deletebypsu: delete: tags: - 1. Управління згодою # Привязка к глобальному тегу summary: Видалення згоди власником рахунків parameters: - name: consentID in: header description: Ідентифікатор згоди required: true type: string - name: X-Request-ID in: header description: Унікальний ідентифікатор запиту згенерований стороною-ініціатором required: true type: UUID security: - bearerAuth: [] responses: '202': description: OK schema: type: object properties: now: type: object properties: rfc2822: type: string '204': description: Згоду видалено headers: X-Request-ID: description: Унікальний ідентифікатор запиту згенерований стороною-ініціатором required: true schema: type: string example: cae7fa99-80b6-4eb3-88c1-0f5004ae3e13 '400': description: Помилковий запит content: application/json: schema: $ref: '#/components/schemas/ErrorMessage4__' '401': description: Запит не авторизован content: application/json: schema: $ref: '#/components/schemas/ErrorMessage4__' '500': description: Внутрішня помилка серверу /accounts: get: tags: - 2. Отримання відомостей по рахункам згоди (баланс, виписка) # Привязка к глобальному тегу summary: Отримання ідентифікаторів рахунків parameters: - name: withBalance in: query description: Ознака необхідності надання даних балансу required: true type: bool default: "true" - name: consentID in: header description: Ідентифіктор згоди required: true type: string - name: X-Request-ID in: header description: Унікальний ідентифікатор запиту згенерований стороною-ініціатором required: true type: UUID - name: PSU-IP-Address in: header description: IP адреса, з якої власник рахунку ініціює запит required: true type: string default: "192.168.0.0" security: - bearerAuth: [] responses: '200': description: Дані рахунків надано headers: X-Request-ID: description: Унікальний ідентифікатор запиту згенерований стороною-ініціатором required: true schema: type: string example: cae7fa99-80b6-4eb3-88c1-0f5004ae3e13 content: application/json: schema: $ref: '#/components/schemas/AccountsDetails' '202': description: OK schema: type: object properties: now: type: object properties: rfc2822: type: string '400': description: Помилковий запит content: application/json: schema: $ref: '#/components/schemas/ErrorMessage4__' '401': description: Запит не авторизован content: application/json: schema: $ref: '#/components/schemas/ErrorMessage4__' '500': description: Внутрішня помилка серверу /accounts/{accountID}: get: tags: - 2. Отримання відомостей по рахункам згоди (баланс, виписка) # Привязка к глобальному тегу summary: Отримання даних по ідентифікатору рахунку (разом із балансом) parameters: - name: accountID in: path description: Ідентифікатор рахунку required: true type: string - name: withBalance in: query description: Ознака необхідності надання даних балансу required: true type: bool default: "true" - name: consentID in: header description: Ідентифікатор згоди required: true type: string - name: X-Request-ID in: header description: Унікальний ідентифікатор запиту згенерований стороною-ініціатором required: true type: UUID - name: PSU-IP-Address in: header description: IP адреса, з якої власник рахунку ініціює запит required: true type: string default: "192.168.0.0" security: - bearerAuth: [] responses: '200': description: Дані по рахунку надано headers: X-Request-ID: description: Унікальний ідентифікатор запиту згенерований стороною-ініціатором required: true schema: type: string example: cae7fa99-80b6-4eb3-88c1-0f5004ae3e13 content: application/json: schema: $ref: '#/components/schemas/AccountDetail' '202': description: OK schema: type: object properties: now: type: object properties: rfc2822: type: string '400': description: Помилковий запит content: application/json: schema: $ref: '#/components/schemas/ErrorMessage4__' '401': description: Запит не авторизован content: application/json: schema: $ref: '#/components/schemas/ErrorMessage4__' '500': description: Внутрішня помилка серверу /accounts/{accountID}/balances: get: tags: - 2. Отримання відомостей по рахункам згоди (баланс, виписка) # Привязка к глобальному тегу summary: Отримання балансу по рахунку згоди parameters: - name: accountID in: path description: Ідентифікатор рахунку required: true type: string - name: consentID in: header description: Ідентифікатор згоди required: true type: string - name: X-Request-ID in: header description: Унікальний ідентифікатор запиту згенерований стороною-ініціатором required: true type: UUID - name: PSU-IP-Address in: header description: IP адреса, з якої власник рахунку ініціює запит required: true type: string default: "192.168.0.0" security: - bearerAuth: [] responses: '200': description: Дані по рахунку надано headers: X-Request-ID: description: Унікальний ідентифікатор запиту згенерований стороною-ініціатором required: true schema: type: string example: cae7fa99-80b6-4eb3-88c1-0f5004ae3e13 content: application/json: schema: $ref: '#/components/schemas/AccountDetail' '202': description: OK schema: type: object properties: now: type: object properties: rfc2822: type: string '400': description: Помилковий запит content: application/json: schema: $ref: '#/components/schemas/ErrorMessage4__' '401': description: Запит не авторизован content: application/json: schema: $ref: '#/components/schemas/ErrorMessage4__' '500': description: Внутрішня помилка серверу /accounts/{accountID}/transactions: get: tags: - 2. Отримання відомостей по рахункам згоди (баланс, виписка) # Привязка к глобальному тегу summary: Отримання виписки по рахунку згоди parameters: - name: accountID in: path description: Ідентифікатор рахунку required: true type: string - name: withBalance in: query description: Ознака необхідності надання даних балансу required: true type: bool default: "true" - name: bookingStatus in: query description: Статус платіжної операції required: true type: string example: ["booked", "pending" , "both", "information", "all"] - name: dateFrom in: query description: Дата, з якої отримується виписка type: string required: true pattern: yyyy-MM-dd example: 2025-01-25 - name: dateTo in: query description: Дата, до якої отримується виписка type: string pattern: yyyy-MM-dd example: 2025-01-25 - name: X-Request-ID in: header description: Унікальний ідентифікатор запиту згенерований стороною-ініціатором required: true type: UUID - name: PSU-IP-Address in: header description: IP адреса, з якої власник рахунку ініціює запит required: true type: string default: "192.168.0.0" - name: Accept in: header description: Формат бажаної відповіді після визначення header HTTP required: false type: string default: 'json' security: - bearerAuth: [] responses: '200': description: Виписку надано headers: X-Request-ID: description: Унікальний ідентифікатор запиту згенерований стороною-ініціатором required: true schema: type: string example: cae7fa99-80b6-4eb3-88c1-0f5004ae3e13 Content-Type: required: true schema: type: string example: application/json content: application/json: schema: $ref: '#/components/schemas/AccountPayments' '202': description: OK schema: type: object properties: now: type: object properties: rfc2822: type: string '400': description: Помилковий запит content: application/json: schema: $ref: '#/components/schemas/ErrorMessage4__' '401': description: Запит не авторизован content: application/json: schema: $ref: '#/components/schemas/ErrorMessage4__' '500': description: Внутрішня помилка серверу /payments/instant-credit-transfers: post: tags: - 3. Управління платежами # Привязка к глобальному тегу summary: Ініцюювання платежу parameters: - name: Content-Type in: header description: Тип контенту, що передається мережею Інтернет по протоколу HTTP required: true type: string default: "application/json" - name: X-Request-ID in: header description: Унікальний ідентифікатор запиту згенерований стороною-ініціатором required: true type: UUID - name: PSU-IP-Address in: header description: IP адреса, з якої власник рахунку ініціює запит required: true type: string default: "192.168.0.0" - name: PSU-ID in: header description: Значення ідентифікатору клієнта в банку (IBAN) required: true type: string default: "UA453065000000026200700028937" - name: PSU-ID-Type in: header description: Тип ідентифікатора власника рахунку (наразі це IBAN, в подальшому можливі варіанти "телефон", "ІПН" ) required: true type: string default: "UA453065000000026200700028937" - name: TPP-SCA-Approach-Preference in: header description: Список підходів до потоку, за бажаним приорітетом надавача послуг, після проходження авторизаації required: true type: string default: "decoupled, redirect" - name: TPP-Redirect-URI in: header description: Redirect URI after successfull authentication required: true type: string default: "https://provider.app/consent/{consentID}/authorization/" - name: TPP-Nok-Redirect-URI in: header description: Redirect URI after not successfull authentication required: true type: string default: 'https://provider.app/consent/{consentID}/authorization/' requestBody: required: true content: application/json: schema: type: object required: - debtorAccount - creditorAccount - creditorAddress - creditor - instructedAmount - remittanceInformationUnstructured properties: debtorAccount: type: object properties: iban: type: string default: UA453065000000026200700028937 currency: type: string default: UAH creditorAccount: type: object properties: iban: type: string default: UA453065000000026200700028937 currency: type: string default: UAH creditor: properties: name: type: string default: Назва отримувача creditorIdType: type: string default: інтернет магазин creditorId: type: string default: U8456799 instructedAmount: type: object properties: amount: type: string default: 44.56 currency: type: string default: UAH remittanceInformationUnstructured: type: array items: type: string default: ["призначення1", "призначення2" ] security: - bearerAuth: [] responses: '201': description: Платіж ініційовано headers: Location: description: Посилання на запит деталей платежу required: true style: simple schema: type: string example: /payments/instant-credit-transfers/e89f3796-fc51-4c1a-89fd-3f21b0367efd X-Request-ID: description: Унікальний ідентифікатор запиту згенерований стороною-ініціатором required: true schema: type: string example: cae7fa99-80b6-4eb3-88c1-0f5004ae3e13 content: application/json: schema: type: object required: - transactionStatus - paymentId - _links - psuMessage properties: transactionStatus: description: Статус згоди type: string example: "RCVD / ACTC / PDNG / ACSC / ACCC / RJCT" paymentId: description: Ідентифікатор платежу type: string example: e89f3796-fc51-4c1a-89fd-3f21b0367efd _links: description: Посилання, що стосуються платежу type: array items: type: object properties: status: type: string example: /payments/instant-credit-transfers/e89f3796-fc51-4c1a-89fd-3f21b0367efd/status startAuthorisationWithPsuIdentification: type: string example: /payments/instant-credit-transfers/e89f3796-fc51-4c1a-89fd-3f21b0367efd/authorization psuMessage: description: Посилання, що стосуються платежу example: Перейдіть за посиланнями '202': description: OK schema: type: object properties: now: type: object properties: rfc2822: type: string '400': description: Помилковий запит content: application/json: schema: $ref: '#/components/schemas/ErrorMessage4__' '401': description: Запит не авторизован content: application/json: schema: $ref: '#/components/schemas/ErrorMessage4__' '500': description: Внутрішня помилка серверу /payments/instant-credit-transfers/{paymentID}/authorizations: post: tags: - 3. Управління платежами # Привязка к глобальному тегу summary: Ініціювання авторизації платежу parameters: - name: paymentID in: path description: Ідентифікатор платежу required: true type: string default: "" - name: Content-Type in: header description: Тип контенту, що передається мережею Інтернет по протоколу HTTP required: true type: string default: "application/json" - name: X-Request-ID in: header description: Унікальний ідентифікатор запиту згенерований стороною-ініціатором required: true type: UUID - name: PSU-IP-Address in: header description: IP адреса, з якої власник рахунку ініціює запит required: true type: string default: "192.168.0.0" - name: PSU-ID in: header description: Значення ідентифікатору клієнта в банку (IBAN) required: true type: string default: "UA453065000000026200700028937" - name: PSU-ID-Type in: header description: Тип ідентифікатора власника рахунку (наразі це IBAN, в подальшому можливі варіанти "телефон", "ІПН" ) required: true type: string default: "UA453065000000026200700028937" - name: TPP-SCA-Approach-Preference in: header description: Список підходів до потоку, за бажаним приорітетом надавача послуг, після проходження авторизаації required: true type: string default: "decoupled, redirect" - name: TPP-Redirect-URI in: header description: Redirect URI after successfull authentication required: true type: string default: "https://provider.app/consent/{consentID}/" - name: TPP-Nok-Redirect-URI in: header description: Redirect URI after not successfull authentication required: true type: string default: 'https://provider.app/consent/{consentID}/' security: - bearerAuth: [] responses: '201': description: Платіж направлено на авторизацію headers: X-Request-ID: description: Унікальний ідентифікатор запиту згенерований стороною-ініціатором required: true schema: type: string example: cae7fa99-80b6-4eb3-88c1-0f5004ae3e13 ASPSP-SCA-Approach: description: Спосіб авторизації клієнта на стороні банку required: true schema: type: string example: cae7fa99-80b6-4eb3-88c1-0f5004ae3e13 content: application/json: schema: type: object required: - scaStatus - authorisationId - _links - psuMessage properties: scaStatus: title: Статус авторизації платежу type: string example: started authorisationId: title: Унвкальний ідентифікатор процесу авторизації платежу type: string example: started _links: description: Посилання на авторизацію і статус type: object properties: scaStatus: type: string title: посилання для отримання статусу авторизації example: "/payments/instant-credit-transfers/e89f3796-fc51-4c1a-89fd-3f21b0367efd/authorizations/status" psuMessage: description: Повідомлення користувачу type: string example: Для більш детальної інформації перейдіть за посиланням ..... '202': description: OK schema: type: object properties: now: type: object properties: rfc2822: type: string '400': description: Помилковий запит content: application/json: schema: $ref: '#/components/schemas/ErrorMessage4__' '401': description: Запит не авторизован content: application/json: schema: $ref: '#/components/schemas/ErrorMessage4__' '500': description: Внутрішня помилка серверу /payments/instant-credit-transfers/{paymentID}/status: get: tags: - 3. Управління платежами # Привязка к глобальному тегу summary: Статус платежу parameters: - name: paymentID in: path description: Ідентифікатор платежу required: true type: string default: "" - name: X-Request-ID in: header description: Унікальний ідентифікатор запиту згенерований стороною-ініціатором required: true type: UUID - name: Accept in: header description: Тип контенту, що має повернутися по протоколу HTTP required: true type: string default: "json" security: - bearerAuth: [] responses: '200': description: Статус платежу надано headers: X-Request-ID: description: Унікальний ідентифікатор запиту згенерований стороною-ініціатором required: true schema: type: string example: cae7fa99-80b6-4eb3-88c1-0f5004ae3e13 ASPSP-SCA-Approach: description: Спосіб авторизації клієнта на стороні банку required: true schema: type: string example: cae7fa99-80b6-4eb3-88c1-0f5004ae3e13 content: application/json: schema: type: object required: - transactionStatus - authorisationId - _links - psuMessage properties: transactionStatus: title: Статус платежу type: string example: (RCVD / ACTC / PDNG / ACSC/ ACCC / RJCT) authorisationId: title: Унвкальний ідентифікатор процесу авторизації платежу type: string example: started _links: description: Посилання на авторизацію і статус type: object properties: scaStatus: type: string title: посилання для отримання статусу авторизації example: "/payments/instant-credit-transfers/e89f3796-fc51-4c1a-89fd-3f21b0367efd/authorizations/status" psuMessage: description: Повідомлення користувачу type: string example: Для більш детальної інформації перейдіть за посиланням ..... '202': description: OK schema: type: object properties: now: type: object properties: rfc2822: type: string '400': description: Помилковий запит content: application/json: schema: $ref: '#/components/schemas/ErrorMessage4__' '401': description: Запит не авторизован content: application/json: schema: $ref: '#/components/schemas/ErrorMessage4__' '500': description: Внутрішня помилка серверу components: securitySchemes: bearerAuth: # Arbitrary name for the security scheme type: http scheme: bearer #bearerFormat: JWT # Optional, usually JWT schemas: ErrorMessage4__: type: object required: - apiClientMessages properties: apiClientMessages: description: Інформація про помилку type: array items: properties: category: title: категорія помилки code: title: код помилки text: title: текст помилки _links: title: посилання AccountsDetails: type: object required: - accounts properties: accounts: description: Pахунки type: array items: properties: resourceId: description: Ідентикатор ресурсу (рахунку) type: string example: "5357878271d878787878d787" iban: description: ІBAN type: string example: "UA453065000000026200700028937" currency: description: Валюта type: string example: "UAH" name: description: Назва type: string example: "Ім'я власника" balances: description: type: object properties: balanceAmount: type: object properties: currency: description: Валюта type: string example: "UAH" amount: description: type: string example: "UAH" referenceDate: description: Дата, на яку розраховано баланс type: string pattern: yyyy-MM-dd example: 2025-01-25 balanceType: description: Дата, на яку розраховано баланс type: string example: "CACC" AccountDetail: type: object required: - account properties: account: description: Pахунок type: object properties: iban: description: ІBAN type: string example: "UA453065000000026200700028937" currency: description: Валюта type: string example: "UAH" balances: description: type: object properties: balanceAmount: type: object properties: currency: description: Валюта type: string example: "UAH" amount: description: type: string example: "23.67" referenceDate: description: Дата, на яку розраховано баланс type: string pattern: yyyy-MM-dd example: 2025-01-25 balanceType: description: Дата, на яку розраховано баланс type: string example: "CACC" AccountPayments: type: object required: - account - transactions - balances properties: account: description: Pахунок type: object properties: iban: description: ІBAN type: string example: "UA453065000000026200700028937" balances: description: type: object properties: balanceAmount: type: object properties: currency: description: Валюта type: string example: "UAH" amount: description: type: string example: "23.67" referenceDate: description: Дата, на яку розраховано баланс type: string pattern: yyyy-MM-dd example: 2025-01-25 balanceType: description: Дата, на яку розраховано баланс type: string example: "CACC" transactions: type: object properties: booked: type: array items: type: object properties: transactionId: type: string creditor: type: object properties: name: type: string creditorAccount: type: object properties: iban: type: string debtor: type: object properties: name: type: string debtorAccount: type: object properties: iban: type: string transactionAmount: type: object properties: currency: type: string amount: type: string bookingDate: type: string pattern: yyyy-MM-dd example: 2025-01-25 valueDate: type: string remittanceInformationUnstructured: type: array items: type: string default: ["text1", "text2"]