XPAY
      • Sharing URL Link copied
      • /edit
      • View mode
        • Edit mode
        • View mode
        • Book mode
        • Slide mode
        Edit mode View mode Book mode Slide mode
      • Customize slides
      • Note Permission
      • Read
        • Owners
        • Signed-in users
        • Everyone
        Owners Signed-in users Everyone
      • Write
        • Owners
        • Signed-in users
        • Everyone
        Owners Signed-in users Everyone
      • Engagement control Commenting, Suggest edit
      • Invitee
      • No invitee
    • Publish Note

      Publish Note

      Everyone on the web can find and read all notes of this public team.
      Once published, notes can be searched and viewed by anyone online.
      See published notes
      Please check the box to agree to the Community Guidelines.
    • Commenting
      Permission
      Disabled Forbidden Owners Signed-in users Everyone
    • Enable
    • Permission
      • Forbidden
      • Owners
      • Signed-in users
      • Everyone
    • Suggest edit
      Permission
      Disabled Forbidden Owners Signed-in users Everyone
    • Enable
    • Permission
      • Forbidden
      • Owners
      • Signed-in users
    • Versions and GitHub Sync
    • Note settings
    • Engagement control
    • Transfer ownership
    • Delete this note
    • Insert from template
    • Import from
      • Dropbox
      • Google Drive
      • Gist
      • Clipboard
    • Export to
      • Dropbox
      • Google Drive
      • Gist
    • Download
      • Markdown
      • HTML
      • Raw HTML
Menu Note settings Sharing URL Help
Menu
Options
Versions and GitHub Sync Engagement control Transfer ownership Delete this note
Import from
Dropbox Google Drive Gist Clipboard
Export to
Dropbox Google Drive Gist
Download
Markdown HTML Raw HTML
Back
Sharing URL Link copied
/edit
View mode
  • Edit mode
  • View mode
  • Book mode
  • Slide mode
Edit mode View mode Book mode Slide mode
Customize slides
Note Permission
Read
Owners
  • Owners
  • Signed-in users
  • Everyone
Owners Signed-in users Everyone
Write
Owners
  • Owners
  • Signed-in users
  • Everyone
Owners Signed-in users Everyone
Engagement control Commenting, Suggest edit
Invitee
No invitee
Publish Note

Publish Note

Everyone on the web can find and read all notes of this public team.
Once published, notes can be searched and viewed by anyone online.
See published notes
Please check the box to agree to the Community Guidelines.
Engagement control
Commenting
Permission
Disabled Forbidden Owners Signed-in users Everyone
Enable
Permission
  • Forbidden
  • Owners
  • Signed-in users
  • Everyone
Suggest edit
Permission
Disabled Forbidden Owners Signed-in users Everyone
Enable
Permission
  • Forbidden
  • Owners
  • Signed-in users
Import from Dropbox Google Drive Gist Clipboard
   owned this note    owned this note      
Published Linked with GitHub
Subscribed
  • Any changes
    Be notified of any changes
  • Mention me
    Be notified of mention me
  • Unsubscribe
Subscribe
УКР | [ENG](https://hackmd.io/ijxPm0xtTpycgTjuU_NHQQ) ![](https://i.imgur.com/ULmPUgP.jpg) # Загальна інформація по підключенню (API) :::info [TOC] ::: ## Опис заходів безпеки :::warning :bulb: Для взаємодії з системою XPAY необхідно дотримуватись певних правил безпеки: - мережеве підключення виконується в рамках пулу дозволених IP адрес Партнера. - обмін даних відбувається в рамках захищеного [SSL протоколом](https://uk.wikipedia.org/wiki/SSL) з'єднання. - пакет даних підлягає обов'язковому шифруванню з використанням персонального публічного ключа (опис ключів див. нижче). - Партнер надсилає запити у вигляді JSON структури (в кодуванні UTF-8). ::: ## Параметри доступу до API ### URI [Оператор](https://hackmd.io/PxQXIeSiSUunLropfg1LRg#%D0%9E%D0%BF%D0%B5%D1%80%D0%B0%D1%82%D0%BE%D1%80) надає [Партнеру](https://hackmd.io/PxQXIeSiSUunLropfg1LRg#%D0%9F%D0%B0%D1%80%D1%82%D0%BD%D0%B5%D1%80) можливість працювати у двох середовищах: **тестовому** (налаштування системи Партнера та тестові запити API) та **продуктовому** (безпосередня робота з клієнтами). Адреси для запитів API в залежності від середовища: **Тестове середовище** ``` https://stage-papi.xpaydirect.com/xpay ``` **Продуктове середовище** ``` https://papi.xpaydirect.com/xpay ``` ### Токен Партнера **"Partner token"** - унікальний ідентифікатор Партнера ([токен](https://uk.wikipedia.org/wiki/%D0%A2%D0%BE%D0%BA%D0%B5%D0%BD_(%D0%BA%D1%80%D0%B8%D0%BF%D1%82%D0%BE%D0%B2%D0%B0%D0%BB%D1%8E%D1%82%D0%B8))), що генерується Оператором та використовується при кожному запиті **для ідентифікації Партнера** в системі. Токен має вигляд рядка, сформованого з набору цифр та латинських літер, розділених символом "-". :::info Всі методи доступні за **тестовим токеном**: ~~~ 72a8ddb8-9145-4a41-af1a-8c48ecaa4be1 ~~~ ::: ### RSA ключі Взаємодія Партнера з системою XPAY виконується за допомогою [алгоритмів шифрування RSA](https://uk.wikipedia.org/wiki/RSA), які вимагають обміну персональними ключами Оператора та Партнера. Для реалізації алгоритму необхідно використовувати: приватну частину ключа Партнера **"private key"** та публічну частину ключа Оператора **"public key XPAY"**. :::info **Приватний ключ Партнера "private key"** - секретний криптографічний код, створений з використанням алгоритмів шифрування, що генерується у парі з публічним ключем на стороні Партнера та застосовується для **підпису пакета даних**. **Публічний ключ Партнера "public key"** - відкритий криптографічний код, створений з використанням алгоритмів шифрування, що генерується у парі з приватним ключем на стороні Партнера та передається Оператору для **верифікації підпису Партнера** в системі. Приклад команд для генерування пари ключів та формування **публічної частини**: ~~~ openssl genrsa -out keypair.pem 2048 ~~~ ~~~ openssl rsa -in keypair.pem -pubout -out publickey.crt ~~~ **Публічний ключ Оператора "public key XPAY"** - відкритий криптографічний код, що генерується на стороні Оператора та застосовується для криптоперетворення (шифрування) пакета даних: <details> <summary>Ключ для тестового середовища</summary> <br> ~~~ -----BEGIN PUBLIC KEY----- MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0IH2V0Ot1ej4FdOihujG ON37sqql62vFFR/4IK+w4xqHRvD+SEwwkLL9EO72e42bV9VaKOqKbX81A+0hbBXi W7axjHU2Sc97EXTHjpwX++HduUXbXhRteyzcHDLZCGKT8WzoNgQeXcieLUYUp2bb gjElGecKprcprkMeHmffmelwlzcv61auGU0o10CTyyCqhOKofdqJq6A2KOBCLL49 5z1700oCRo9qL4loe95r4wGh6AmHZNvAnAwLgzwzyLvWCz479CVIWEaMY/+uczfL 0yRjN+8uqNK3A09wOD+wO1I+YfU9YXcQ75L8ibxzWcNgMHrhJQ9ZtnoVltiTWEEB 9QIDAQAB -----END PUBLIC KEY----- ~~~ </details> <details> <summary>Ключ для продуктового середовища</summary> <br> ~~~ -----BEGIN PUBLIC KEY----- MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA9+1AEFfD9MoO0IWeMk3f aFoYBBekFgHmUGM48AVh6BW/s5r16mtUfMfRfezVgqluwV/liEd6hArmmEZIKwYE mJoAYuY/ny9QJpc8zY+toR5IJEtYxfStHmVwKSuvHL3KY/U/Ok5UUT2u075JPZb+ FtDZwW9KXkwmT53HQ6iS0XFyy621vGrs6XcdGwO6eZPptkvc8SYKDwClgLjI69Iz b6K/dfdQUioMPvZOXpdzrEQXjnipmsYh1VxOufqsX1SDzqR67Zs114OnHWAZhTXE ksUjKavJkCc07T+nu1O/r99rsrRCaQODVq8SMAoK1vxJLf29WFv4ydp4vIk+n98/ DQIDAQAB -----END PUBLIC KEY----- ~~~ </details> ::: ### Порядок ідентифікації та верифікації Партнера - Оператор генерує та передає Партнеру унікальний токен **"partner token"** та свій публічний ключ **"public key XPAY"** для взаємодії з системою Оператора. - Партнер генерує пару персональних ключів: приватний **"private key"** (для генерування підпису) та публічний **"public key"** (передає Оператору для верифікації підпису). - Партнер надсилає запит у вигляді підписаного приватним ключем зашифрованного **пакета даних** та проходить верифікацію підпису на стороні Оператора за допомогою публічного ключа Партнера. ### Підключення Тестового Партнера ![](https://i.imgur.com/gtxKB22.png) :::info Для тестування будь-яких операцій та ознайомлення з сервісами системи XPAY заведено **Тестового Партнера**. Див. деталі підключення у розділі: ["Параметри підключення Тестового Партнера"](https://hackmd.io/kGejjgk0QaiwfpoZFnTadA). ::: ## Правила надсилання запитів/відповідей *Коди відповідей та ознаки фатальності див. у табл. ["Коди відповідей Оператора "Code"](https://hackmd.io/aBE7H5cfQ-iqaN3SnwaQ-w?view#%D0%9A%D0%BE%D0%B4%D0%B8-%D0%B2%D1%96%D0%B4%D0%BF%D0%BE%D0%B2%D1%96%D0%B4%D0%B5%D0%B9-%D0%9E%D0%BF%D0%B5%D1%80%D0%B0%D1%82%D0%BE%D1%80%D0%B0-%E2%80%9CCode%E2%80%9D).* Отримання http-коду з ознакою фатальності **"ні"** передбачає продовження виконання операції у системі Оператора чи Партнера. Для запиту поточного **статусу обробки операції** [[20003]](https://hackmd.io/fvd8btZLQXywluia6w5uxg) необхідно повторювати запит з надісланими раніше параметрами до отримання http-коду з ознакою фатальності **“так”**. У відповіді змінюватиметься статус проведення операції. :::warning Надсилання повторного запиту Оператору здійснюється: **не частіше 1-го разу за 60 сек**. ::: Час на надсилання **відповіді** обмежений та складає **55 сек**. Якщо обробка операції не завершена - система XPAY формує відповідь з кодом `102`. :::warning Отримання `timeout` на будь-який API запит, в тому числі на запит статусу - необхідно розцінювати, як відповідь з кодом `102` та продовжувати запитувати статус до отримання фатального коду. ::: ## Структура запиту **Запит Партнера** - пакет даних у вигляді [JSON структури](https://uk.wikipedia.org/wiki/JSON), що надсилається Оператору для проведення операції та складається з 4-х атрибутів: "Partner", "Data", "KeyAES" та "Sign" (опис атрибутів див. нижче). Для криптоперетворення запиту та формування підпису ключа оберіть один з двох алгоритмів: * [PKCS](https://ru.wikipedia.org/wiki/PKCS) * [OAEP](https://ru.wikipedia.org/wiki/%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0%D0%BB%D1%8C%D0%BD%D0%BE%D0%B5_%D0%B0%D1%81%D0%B8%D0%BC%D0%BC%D0%B5%D1%82%D1%80%D0%B8%D1%87%D0%BD%D0%BE%D0%B5_%D1%88%D0%B8%D1%84%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5_%D1%81_%D0%B4%D0%BE%D0%BF%D0%BE%D0%BB%D0%BD%D0%B5%D0%BD%D0%B8%D0%B5%D0%BC) :::success <details> <summary>Приклад запиту Партнера з зашифрованими даними, ключем та підписом</summary> <br> ~~~md { "Partner": { "PartnerToken": "72a8ddb8-9145-4a41-af1a-8c48ecaa4be1", "OperationType": 10005 }, "Data": "AAAAAAAAAAAAAAAAAAAAAC+kIDAcwzpMy55qVKGeMLuOWh0INgMBfRkYyIUHpw89vsN0HwRLc8B3bPVtwONPEnm4AMAyltWL+OFNCZJL5ODc/4x6/vT8pmsOhoQcmSS1gtr3FcvbyHOIYwLDC+mQxMWyEvfN0bmsR9pAqkQh67/JzFyuS8KZ2gtT4IAcnq2vYyn4WsY6JBuJVpHEvipHB6orQAcEHZ9UjS4JGh5OV/JG7OMFSunoblniE1/YO4sT", "KeyAES": "et/DigMfEL16uH+8Trvp86/jd7N6CUsK8C8jvcQMJSKnDfkirkRS760uKmtDnVapGIJhAK5CmN+/tsqMxSH+czDYSGotHmW3BacocccgrrHbfdtKPuKbLCAGmDo0SlISj2URix4kJTGZztqy8pWTkVde0RAr7SOWwUHBlSIRklDLwEvGb45kmnqeV2AjCA/EiTMMez/rRt3T5Bc674Cc9G/6usu8yRj9Hw2q4ZLmcGRSLxae196vt9aZBmeOvy71gjUaedfxEud0ldLPvE0FyxE5nmlz59GPURvD9UT0fbFH3zdEghJ5hm+oTaDuvJFobCrjAiXpQGpryywHLFwuOw==", "Sign": "Ehn3kb3Cqk+B8wqJJEwl5Kwj68ldaq0pfReEUfpGrC68pZQEPl/K8VYuUBhfhDkklVOsOsxqTCAW0izitUyfqd67Afdg6dRxO5leUuKfS9llhrJwYLbcWVf36Rh+Xva95p22GBlbmS2/DD3f0b1zFZoNv9AZe62EMe37d11S6G42RJfSM9z2HQCOcs50XEID8Z56wI3ezHoeOk8uvKcMaZo+exWVr0pqg/LoN0yM53vQn/2t7uwIkt8y/lTPTo6jW2EXtA/lp5SiBZx0Jnh9QPg2I/h7WEa1oYysNcizHeXIr6j6+U7cquQp8XmJh1pJodAhMiG2jMRgLgPlWq0PKg==" } ~~~ </details> ::: ### 1. Partner **"Partner"** - JSON структура запиту, що передає дані для ідентифікації Партнера у системі та визначення типу операції. Даний атрибут формується з наступних параметрів: `PartnerToken`, `OperationType` та `Locale`. | Параметр | Обов'яз-ковість | Тип | Опис |Приклад| |:----:|:----:|:----:|----|:----:| | `PartnerToken` | Так | Рядок | Унікальний ідентифікатор Партнера в системі Оператора (токен), що використовується при кожному запиті для ідентифікації Партнера. | Для **тестового середовища** рекомендуємо використовувати: </br> `72a8ddb8-9145-4a41-af1a-8c48ecaa4be1` | | `OperationType`| Так | Ціле | Цифровий код (як фінансовий, так і інформаційний), що присвоюється Оператором для визначення типу операції Партнера. Код відображається у назві кожного запиту у вигляді: **[код] "назва запиту"**. |`10005`,`10102`,`20003` та ін. (згідно довідника "[Коди типів операцій “OperationType](https://hackmd.io/aBE7H5cfQ-iqaN3SnwaQ-w#%D0%9A%D0%BE%D0%B4%D0%B8-%D1%82%D0%B8%D0%BF%D1%96%D0%B2-%D0%BE%D0%BF%D0%B5%D1%80%D0%B0%D1%86%D1%96%D0%B9-%E2%80%9COperationType%E2%80%9D)”). | | `Locale` | Ні | Рядок | Локаль (мова) відображення елементів інтерфейсу, допоміжних файлів та документації. | `uk`-українська (за замовчув.), </br>`en`-англійська. :::success <details> <summary>Приклад JSON структури "Partner"</summary> <br> ~~~md { "PartnerToken": "72a8ddb8-9145-4a41-af1a-8c48ecaa4be1", "OperationType": 10005, "Locale": "uk" } ~~~ </details> ::: ### 2. Data **"Data"** - зашифровані за алгоритмом [AES](https://uk.wikipedia.org/wiki/Advanced_Encryption_Standard) дані операції у вигляді рядка. У структурі "Data" в залежності від типу операції передаються різні параметри та структури даних. Одна з основних структур - `Transaction`. #### Структура "Transaction" :::danger Структура **"Transaction"** передається кожного разу з унікальним значенням параметра `TransactionID` (див. опис нижче), навіть, якщо на попередній запит отримана фінальна відповідь, наприклад, *"про помилку виконання операції"* - в такому випадку повторний запит надсилається з новим унікальним значенням `TransactionID`. ::: | Параметр | Обов'яз-ковість | Тип | Опис | Приклад | |:----:|:----:|:----:|----|:----:| |`Transaction`^1^|Так/Ні|Структура|Структура даних, що містить інформацію про транзакцію.|Див. приклад нижче.| :::warning ^1^ Структура **"Transaction"** не обов'язкова лише для інформаційних запитів (таких як, [[20001]](https://hackmd.io/c-2sDICDRGeplJ-QL8bETw), [[20002]](https://hackmd.io/L9EeXtQYRDCQD_IhAPKhMw), [[20003]](https://hackmd.io/fvd8btZLQXywluia6w5uxg) та ін.), але для всіх фінансових операцій - обов'язкова. ::: Параметри структури **"Transaction"**: | Параметр | Обов'яз-ковість | Тип | Опис |Приклад| |:----:|:----:|:----:|----|:----:| |`TransactionID`|Так|Рядок|Унікальний ідентифікатор транзакції у системі Партнера.| `45913135c6e2be0cbf5`| |`TerminalID`|Так|Рядок|Унікальний ідентифікатор термінала у системі Партнера. У разі відсутності - передається значення `1`.|`1`| |`DateTime`|Ні|Рядок|Дата та час проведення транзакції. Формат: YYYYMMDD HH24:MM:SS.|`20220521 06:41:04`| :::success <details> <summary>Приклад JSON структури "Transaction"</summary> <br> ~~~md { "Transaction": { "TransactionID": "8fd04e6ec7c1", "TerminalID": "802", "DateTime": "20220504 08:14:07" } } ~~~ </details> ::: #### Криптоперетворення даних атрибуту "Data" Розглянемо процес криптоперетворення на прикладі: :::success <details> <summary>Приклад JSON структури "Data", що потрібно зашифрувати</summary> <br> ~~~md { "ClientIP": "133.36.78.88", "PaymentSum": 1000, "PayType": "0", "Phone": "380633214565", "Transaction": { "TerminalID": "1", "DateTime": "20210303_132011", "TransactionID": "123" } } ~~~ </details> ::: #### 2.1. Генерування ключа AES Генеруємо ключ AES довжиною 16 байт, за допомогою якого в подальшому шифруються дані операції за алгоритмом AES-128 в [режимі CBC](https://uk.wikipedia.org/wiki/%D0%A0%D0%B5%D0%B6%D0%B8%D0%BC%D0%B8_%D0%B1%D0%BB%D0%BE%D0%BA%D0%BE%D0%B2%D0%BE%D0%B3%D0%BE_%D1%88%D0%B8%D1%84%D1%80%D1%83%D0%B2%D0%B0%D0%BD%D0%BD%D1%8F) (див. схему нижче, вказівник 2.1). :::success <details> <summary>Згенерований ключ AES для шифрування даних ([]byte)</summary> <br> ~~~md [49 50 51 52 53 54 55 56 57 48 97 98 99 100 101 102] ~~~ </details> ::: :::success <details> <summary>Згенерований ключ AES для шифрування даних у вигляді рядка (string)</summary> <br> ~~~md 1234567890abcdef ~~~ </details> ::: #### 2.2. Вирівнювання даних операції Перетворюємо дані операції з JSON структури у формат []byte та вирівнюємо їх до х16 байт з кінця символом, що дорівнює кількості доданих символів (див. схему нижче, вказівник 2.2). Наприклад, для додавання 5 байт необхідно додати 5 разів символ "5". :::success <details> <summary>Масив даних, що потрібно зашифрувати ([]byte)</summary> <br> [123 34 67 108 105 101 110 116 73 80 34 58 34 49 51 51 46 51 54 46 55 56 46 56 56 34 44 34 80 97 121 109 101 110 116 83 117 109 34 58 49 48 48 48 44 34 80 97 121 84 121 112 101 34 58 34 48 34 44 34 80 104 111 110 101 34 58 34 51 56 48 54 51 51 50 49 52 53 54 53 34 44 34 84 114 97 110 115 97 99 116 105 111 110 34 58 32 123 34 84 101 114 109 105 110 97 108 73 68 34 58 32 34 49 34 44 32 34 68 97 116 101 84 105 109 101 34 58 32 34 50 48 50 49 48 51 48 51 95 49 51 50 48 49 49 34 44 34 84 114 97 110 115 97 99 116 105 111 110 73 68 34 58 32 34 49 50 51 34 125 125] </details> ::: :::success <details> <summary>ВИРІВНЯНИЙ масив даних, що потрібно зашифрувати ([]byte)</summary> <br> [123 34 67 108 105 101 110 116 73 80 34 58 34 49 51 51 46 51 54 46 55 56 46 56 56 34 44 34 80 97 121 109 101 110 116 83 117 109 34 58 49 48 48 48 44 34 80 97 121 84 121 112 101 34 58 34 48 34 44 34 80 104 111 110 101 34 58 34 51 56 48 54 51 51 50 49 52 53 54 53 34 44 34 84 114 97 110 115 97 99 116 105 111 110 34 58 32 123 34 84 101 114 109 105 110 97 108 73 68 34 58 32 34 49 34 44 32 34 68 97 116 101 84 105 109 101 34 58 32 34 50 48 50 49 48 51 48 51 95 49 51 50 48 49 49 34 44 34 84 114 97 110 115 97 99 116 105 111 110 73 68 34 58 32 34 49 50 51 34 125 125 5 5 5 5 5] </details> ::: #### 2.3. Генерування вектора ініціалізації Генеруємо [вектор ініціалізації](https://uk.wikipedia.org/wiki/%D0%A0%D0%B5%D0%B6%D0%B8%D0%BC%D0%B8_%D0%B1%D0%BB%D0%BE%D0%BA%D0%BE%D0%B2%D0%BE%D0%B3%D0%BE_%D1%88%D0%B8%D1%84%D1%80%D1%83%D0%B2%D0%B0%D0%BD%D0%BD%D1%8F) (див. схему нижче, вказівник 2.3). :::success <details> <summary>Вектор ініціалізації ([]byte)</summary> <br> ~~~md IV = [49 50 51 52 53 54 55 56 57 48 97 98 99 100 101 102] ~~~ </details> ::: #### 2.4. Додавання вектора ініціалізації Додаємо до не шифрованих вирівняних даних у перші 16 байт випадково згенерований вектор ініціалізації (див. схему нижче, вказівник 2.4). #### 2.5. Перетворення даних операції в base64 Отриманий бінарний масив в результаті шифрування ключем AES стандартно перетворюємо на рядок у кодуванні [base64](https://uk.wikipedia.org/wiki/Base64) (див. схему нижче, вказівник 2.5). :::success <details> <summary>Зашифровані дані операції у вигляді рядка (base64)</summary> <br> MTIzNDU2Nzg5MGFiY2RlZi+kIDAcwzpMy55qVKGeMLuOWh0INgMBfRkYyIUHpw89vsN0HwRLc8B3bPVtwONPEnm4AMAyltWL+OFNCZJL5ODc/4x6/vT8pmsOhoQcmSS1gtr3FcvbyHOIYwLDC+mQxMWyEvfN0bmsR9pAqkQh67/JzFyuS8KZ2gtT4IAcnq2vYyn4WsY6JBuJVpHEvipHB6orQAcEHZ9UjS4JGh5OV/JG7OMFSunoblniE1/YO4sT </details> ::: ### 3. KeyAES **"KeyAES"** - зашифрований за алгоритмом RSA ключ AES у вигляді рядка. #### 3.1. Шифрування ключа AES Згенерований вище ключ AES, яким зашифровані дані операції, шифруємо **публічним ключем XPAY** за [алгоритмом PKCS1 v1.5](https://en.wikipedia.org/wiki/PKCS_1) / [OAEP](https://ru.wikipedia.org/wiki/%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0%D0%BB%D1%8C%D0%BD%D0%BE%D0%B5_%D0%B0%D1%81%D0%B8%D0%BC%D0%BC%D0%B5%D1%82%D1%80%D0%B8%D1%87%D0%BD%D0%BE%D0%B5_%D1%88%D0%B8%D1%84%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5_%D1%81_%D0%B4%D0%BE%D0%BF%D0%BE%D0%BB%D0%BD%D0%B5%D0%BD%D0%B8%D0%B5%D0%BC) (див. схему нижче, вказівник 3.1). #### 3.2. Перетворення ключа AES в base64 Отриманий в результаті шифрування бінарний масив стандартно перетворюємо на рядок у кодуванні base64 (див. схему нижче, вказівник 3.2). :::success <details> <summary>Зашифрований ключ AES (base64)</summary> <br> SG/brF1UrUem/2BakqbYnLu6CD6JYqRbB2SdN+xNE89smpnFtsjXfZljtEpbNA3JjJNuPLPU6dxlki1sSvGe1PofVt1HFGKPxqVyMNyhZ4FYqM79A53Iw5ODJJ53UM94kdb2YHT0drRYGNOHeFbIeVluuVMyPhGoVsGkbwONUQ9BE78JKQArHvRoKYJhKzYQ5undnv/oiOCXTfW+5Mt5+qdm7ZmQ80D6NmZJI+IgOFEkaQ9nFdPBuYpOhoFEZiRbxRLNYUNLCVifCaJXoi7GILSHVfXDwx+3kWQX8o91pxEmwmZU/yE/KPtXqINgXVgMoWu7CCMgU576fZyLHy+X7A== </details> ::: ### 4. Sign **"Sign"** - згенерований за алгоритмом RSA підпис у вигляді рядка. #### 4.1. Генерування підпису Зашифрований вище ключ AES (до перетворення на base64) підписуємо **приватним ключем Партнера**: хеш [SHA256](https://uk.wikipedia.org/wiki/SHA-2), за алгоритмом PKCS1 v1.5 / OAEP (див. схему нижче, вказівник 4.1). #### 4.2. Перетворення підпису в base64 Отриманий в результаті підпису бінарний масив стандартно перетворюємо на рядок у кодуванні base64 (див. схему нижче, вказівник 4.2). :::success <details> <summary>Згенерований підпис (base64)</summary> <br> L+H2PL0lOpGZno4cvWG+BsoiGCbJbkHVgZOC2RmVHNM+Y9GHzqAJrzncgfo/ltqZUM6F0/kjaFE5J/MaqLsysSwMd04YRqkc+RNGqBVMj3oPpejOhdYyMQWiuW5x4rOXoI/nYx8IZCtIzloqqwudZApcYEtrajnACqCZKKZmcyXZcB9HUbUi+WULfo6xTtcSx3W5Lwq8p0WQo8l48AzbtOIIMpLULhFu0a6o21Mz28p0qmIybvKtLdlQT8Nj5+j86wsKjdaCzI9rILzI3s+vyVibZIflptwRnhef83NtDSmorAyUIXoIl+cYSdYgxiQTsYnodtt+zr42rKEFjW1Dlw== </details> ::: #### 4.3. Верифікація підпису на стороні Оператора Верифікація підпису проходить за допомогою **публічного ключа Партнера**, під час якої підпис декодується з base64, та отримані дані верифікуються з підписаними: хеш SHA256, за алгоритмом PKCS1 v1.5 / OAEP. Результатом виконання запиту є відповідь системи XPAY, описана нижче у розділі "**Структура відповіді**". ### Схема криптоперетворення ![](https://i.imgur.com/ar56IOl.png) ## Структура відповіді У відповідь на запит операції сервіс Оператора відповідає JSON структурою, що складається з наступних параметрів: `Code`, `Message`, `Data`, `KeyAES`, `Sign`. | Параметр | Обов’яз-ковість | Тип | Опис | Приклад | |:----:|:----:|:----:|----|:----:| | `Code` | Так | Ціле | Код відповіді запиту, або так званий [код стану http](https://uk.wikipedia.org/wiki/%D0%A1%D0%BF%D0%B8%D1%81%D0%BE%D0%BA_%D0%BA%D0%BE%D0%B4%D1%96%D0%B2_%D1%81%D1%82%D0%B0%D0%BD%D1%83_HTTP). Доступні коди наведено у розділі "[Коди відповідей Оператора](https://hackmd.io/aBE7H5cfQ-iqaN3SnwaQ-w?view#%D0%9A%D0%BE%D0%B4%D0%B8-%D0%B2%D1%96%D0%B4%D0%BF%D0%BE%D0%B2%D1%96%D0%B4%D0%B5%D0%B9-%D0%9E%D0%BF%D0%B5%D1%80%D0%B0%D1%82%D0%BE%D1%80%D0%B0-%E2%80%9CCode%E2%80%9D)". | `401` | | `Message` | Так | Рядок | Текстове повідомлення з описом статусу запиту. | `Operation not permitted` | | `Data`^2^ | Так | Структура | Допоміжні дані операції (ідентифікатор операції, URL-підтвердження операції, виписка балансу, статус операцій та ін.) | `"OperationID":11`, </br> `"OperationStatus":10` | | `KeyAES` | Так | Рядок | Зашифрований за алгоритмом RSA ключ AES, яким зашифровані дані операції (base64). Для відповідей із не шифрованими даними - рядок порожній. | див. нижче в прикладі | | `Sign` | Так | Рядок | Згенерований за алгоритмом RSA підпис (base64). Для відповідей із не шифрованими даними – рядок порожній. | див. нижче в прикладі | :::warning ^2^ Параметр **"Data"** у структурі відповіді містить два обов'язкові поля (інші поля формуються залежно від типу операції та її статусу): 1. `OperationID:` - унікальний ідентифікатор операції у системі Оператора. 2. `OperationStatus:` - код статусу обробки операції, наведений у розділі "[Статус обробки операції](https://hackmd.io/aBE7H5cfQ-iqaN3SnwaQ-w?view#%D0%A1%D1%82%D0%B0%D1%82%D1%83%D1%81-%D0%BE%D0%B1%D1%80%D0%BE%D0%B1%D0%BA%D0%B8-%D0%BE%D0%BF%D0%B5%D1%80%D0%B0%D1%86%D1%96%D1%97-%E2%80%9COperationStatus%E2%80%9D)". За наявності у відповіді параметру `Reason` - **причини відхилення операції** - код причини див. в таблиці ["Коди причин відхилення операцій"](https://hackmd.io/aBE7H5cfQ-iqaN3SnwaQ-w#%D0%9A%D0%BE%D0%B4%D0%B8-%D0%BF%D1%80%D0%B8%D1%87%D0%B8%D0%BD-%D0%B2%D1%96%D0%B4%D1%85%D0%B8%D0%BB%D0%B5%D0%BD%D0%BD%D1%8F-%D0%BE%D0%BF%D0%B5%D1%80%D0%B0%D1%86%D1%96%D0%B9-%E2%80%9CReason%E2%80%9D). При аналізі **статусу операції** пріоритетність надається значенню `OperationStatus`. Параметр `Code` має більш інформаційну функцію та показує, чи пройшла обробка згідно з протоколом, чи не виникло внутрішніх помилок та чи всі послуги були доступні. ::: ### Приклади відповідей :::success <details> <summary>Операція проведена успішно ("OperationStatus":10)</summary> <br> ~~~md { "Code": 200, "Message": "done", "Data": { "OperationID": 11, "OperationStatus": 10, "URI": "https://stage-mapi.xpaydirect.com/uk/frame/widget/f3cd72b6-e1ea-406f-9b44-a9b93b401b7f", "uuid": "f3cd72b6-e1ea-406f-9b44-a9b93b401b7f" }, "KeyAES": "", "Sign": "" } ~~~ </details> ::: :::success <details> <summary>Отримано неправильний токен</summary> <br> ~~~md { "Code": 401, "Message": "wrong token", "Data": null, "KeyAES": "", "Sign": "" } ~~~ </details> ::: :::success <details> <summary>Операція недоступна партнеру</summary> <br> ~~~md { "Code": 403, "Message": "operation not permitted", "Data": null, "KeyAES": "", "Sign": "" } ~~~ </details> ::: :::success <details> <summary>Помилка виконання операції ("OperationStatus":21)</summary> <br> ~~~md { "Code": 200, "Message": "done", "Data": { "OperationID": 111, "OperationStatus": 21, "Reason": 3 }, "KeyAES": "", "Sign": "" } ~~~ </details> ::: ## Сервіс Cipher :::warning У разі неможливості реалізації криптоперетворення даних - зверніться до Оператора для підключення Партнера з використанням сервісу шифрування XPAY: ["Cipher" (Cайфер)](https://hackmd.io/iiQYSz-oTuqh5-yUM0vTgQ). ::: ## Довідкові матеріали Опис загальних параметрів системи XPAY див. у розділі ["Довідкові матеріали"](https://hackmd.io/aBE7H5cfQ-iqaN3SnwaQ-w): коди типів операцій, типи платіжних методів, коди статусів обробки операцій, відомості та помилки, що повертаються у відповіді та ін. :::info *При інтеграції для кожного Партнера створюється окремий чат підтримки.* ::: ![](https://i.imgur.com/17gAyWb.png) :arrow_left: [XPAY API Зміст](/Mj2ZqCVpSq6A6Jzm6ladlw) :arrow_left: [XPASS API Зміст](https://hackmd.io/eSq3juGWQLS1wVvJZiTUAQ) <details> <summary>Служба підтримки XPAY</summary> </br> Телефон: +38 093 891 92 00 Email: info@xpay.com.ua Telegram: @xpaysupportbot </details>

Import from clipboard

Advanced permission required

Your current role can only read. Ask the system administrator to acquire write and comment permission.

This team is disabled

Sorry, this team is disabled. You can't edit this note.

This note is locked

Sorry, only owner can edit this note.

Reach the limit

Sorry, you've reached the max length this note can be.
Please reduce the content or divide it to more notes, thank you!

Import from Gist

Import from Snippet

or

Export to Snippet

Are you sure?

Do you really want to delete this note?
All users will lose their connection.

Create a note from template

Create a note from template

Oops...
This template is not available.
Upgrade
All
  • All
  • Team
No template found.

Create custom template

Upgrade

Delete template

Do you really want to delete this template?
Turn this template into a regular note and keep its content, versions, and comments.

This page need refresh

You have an incompatible client version.
Refresh to update.
New version available!
See releases notes here
Refresh to enjoy new features.
Your user state has changed.
Refresh to load new user state.

Sign in

Forgot password

or

By clicking below, you agree to our terms of service.

Sign in via Facebook Sign in via Twitter Sign in via GitHub Sign in via Dropbox Sign in with Wallet
Wallet ( )
Connect another wallet

New to HackMD? Sign up

Help

  • English
  • 中文
  • Français
  • Deutsch
  • 日本語
  • Español
  • Català
  • Ελληνικά
  • Português
  • italiano
  • Türkçe
  • Русский
  • Nederlands
  • hrvatski jezik
  • język polski
  • Українська
  • हिन्दी
  • svenska
  • Esperanto
  • dansk

Documents

Tutorials

Book Mode Tutorial

Slide Mode Tutorial

Contacts

Facebook

Twitter

Discord

Feedback

Send us email

Resources

Releases

Pricing

Blog

Policy

Terms

Privacy

Cheatsheet

Syntax Example Reference
# Header Header 基本排版
- Unordered List
  • Unordered List
1. Ordered List
  1. Ordered List
- [ ] Todo List
  • Todo List
> Blockquote
Blockquote
**Bold font** Bold font
*Italics font* Italics font
~~Strikethrough~~ Strikethrough
19^th^ 19th
H~2~O H2O
++Inserted text++ Inserted text
==Marked text== Marked text
[link text](https:// "title") Link
![image alt](https:// "title") Image
`Code` Code 在筆記中貼入程式碼
```javascript
var i = 0;
```
var i = 0;
:smile: :smile: Emoji list
{%youtube youtube_id %} Externals
$L^aT_eX$ LaTeX
:::info
This is a alert area.
:::

This is a alert area.

Versions and GitHub Sync
Upgrade to Prime Plan

  • Edit version name
  • Delete

revision author avatar     named on  

More Less

No updates to save
Compare with
    Choose a version
    No search result
    Version not found
Sign in to link this note to GitHub
Learn more
This note is not linked with GitHub
 

Feedback

Submission failed, please try again

Thanks for your support.

On a scale of 0-10, how likely is it that you would recommend HackMD to your friends, family or business associates?

Please give us some advice and help us improve HackMD.

 

Thanks for your feedback

Remove version name

Do you want to remove this version name and description?

Transfer ownership

Transfer to
    Warning: is a public team. If you transfer note to this team, everyone on the web can find and read this note.

      Link with GitHub

      Please authorize HackMD on GitHub
      • Please sign in to GitHub and install the HackMD app on your GitHub repo.
      • HackMD links with GitHub through a GitHub App. You can choose which repo to install our App.
      Learn more  Sign in to GitHub

      Push the note to GitHub Push to GitHub Pull a file from GitHub

        Authorize again
       

      Choose which file to push to

      Select repo
      Refresh Authorize more repos
      Select branch
      Select file
      Select branch
      Choose version(s) to push
      • Save a new version and push
      • Choose from existing versions
      Include title and tags
      Available push count

      Upgrade

      Pull from GitHub

       
      File from GitHub
      File from HackMD

      GitHub Link Settings

      File linked

      Linked by
      File path
      Last synced branch
      Available push count

      Upgrade

      Danger Zone

      Unlink
      You will no longer receive notification when GitHub file changes after unlink.

      Syncing

      Push failed

      Push successfully