УКР | [ENG](https://hackmd.io/0g4L6-zjQ-i50rtkVjJTxQ)
:arrow_left: [На Головну](/Mj2ZqCVpSq6A6Jzm6ladlw)

# [10015/10025/10035/10045] Отримання посилання віджета для проходження ідентифікації "BankID/Дія"

## Застосування

Запити [10015/10025/10035/10045] застосовуються для отримання посилання віджета для проходження ідентифікації "[BankID](https://uk.wikipedia.org/wiki/BankID)" або "[Дія](https://uk.wikipedia.org/wiki/%D0%94%D1%96%D1%8F_(%D1%81%D0%B5%D1%80%D0%B2%D1%96%D1%81))".

|"OperationType" | Тип операції |
|:----:|----|
|`10015`|Отримання посилання віджета для проходження ідентифікації з можливістю вибору "BankID" або "Дія".|
|`10025`|Отримання посилання віджета для проходження ідентифікації “BankID”.|
|`10035`|Отримання посилання віджета для проходження ідентифікації “Дія”.|
|`10045` | Отримання посилання віджета для оформлення банківського продукту. |


## Запит

*Опис атрибутів "Partner", "KeyAES" та "Sign" див. у розділі ["Загальна інформація по підключенню (API)"](https://hackmd.io/g3cItPVFStez0ql3Xj-2TA).*

### Структура "Data"

Структура "Data" для запитів [10015/10025/10035/10045] однакова та формується з наступних параметрів:

:::info
<details>
<summary>Формування структури "Data" (приклади наведені нижче)</summary>
<br>

~~~
{
"Phone": "",
"Email": "",
"ClientIP": "",
"FirstName": "",
"LastName": "",
"MiddleName": "",
"BrowserFingerprint": "",
"RedirectURL": "",
"Transaction": {
"TransactionID": "",
"TerminalID": "",
"DateTime": ""
}
}
~~~
</details>
:::

| Параметр | Обов'яз-ковість | Тип | Опис |Приклад|
|:----:|:----:|:----:|----|:----:|
| `Phone` | Так | Рядок | Телефон клієнта у форматі: "380ххххххххх". |`380679335544`|
| `Email` | Ні | Рядок | Email клієнта. |`[e-mail]`|
| `ClientIP` | Ні | Рядок | IP адреса, з якої клієнт ініціює операцію. |`127.0.0.1`|
| `FirstName` | Ні | Рядок | Ім'я клієнта. |`Олег`|
| `MiddleName` | Ні | Рядок | По батькові клієнта. |`Михайлович`|
| `LastName` | Ні | Рядок | Прізвище клієнта. |`Подільський`|
| `RedirectURL` | Ні | Рядок | URL адреса сторінки, на яку буде перенаправлений клієнт після проходження процедури ідентифікації.| `https://partner.com/callback/xpay1`|
| `BrowserFingerprint` | Ні | Рядок | [Цифровий відбиток браузера](https://uk.wikipedia.org/wiki/%D0%A6%D0%B8%D1%84%D1%80%D0%BE%D0%B2%D0%B8%D0%B9_%D0%B2%D1%96%D0%B4%D0%B1%D0%B8%D1%82%D0%BE%D0%BA_%D0%BF%D1%80%D0%B8%D1%81%D1%82%D1%80%D0%BE%D1%8E): [https://m.habr.com/ru/company/oleg-bunin/blog/321294/](https://m.habr.com/ru/company/oleg-bunin/blog/321294/); [https://github.com/valve](https://github.com/valve) |`86a190af26de3a920c62ea19ba0df3a8`|
|`Transaction`|Так|Структура|Структура, що передає дані про транзакцію. Див. розділ ["Структура "Transaction"](https://hackmd.io/g3cItPVFStez0ql3Xj-2TA#2-Data).|Див. нижче.|

## Відповідь

*Загальна інформація по формуванню структури відповіді наведена у розділі [“Загальна інформація по підключенню (API)”](https://hackmd.io/g3cItPVFStez0ql3Xj-2TA?both#%D0%A1%D1%82%D1%80%D1%83%D0%BA%D1%82%D1%83%D1%80%D0%B0-%D0%B2%D1%96%D0%B4%D0%BF%D0%BE%D0%B2%D1%96%D0%B4%D1%96).*

### Структура "Data"

Успішна відповідь на запити [10015/10025/10035/10045] містить посилання у вигляді рядка з назвою `URI` у структурі "Data":

| Параметр | Обов’яз-ковість | Тип | Опис | Приклад |
|:-:|:-:|:-:|-|:-:|
| `URI` |Так| Рядок | Посилання на віджет "BankID/Дія". |`https://stage-mapi.xpaydirect.com/uk/frame/widget/banner-payment`|
|`uuid`|Так|Рядок|Унікальний ідентифікатор, що зв’язує запити віджету. |`f3cd72b6-e1ea-406f-9b44-a9b93b401b7f`|

### Приклади відповідей

:::success
<details>
<summary>Операція проведена успішно</summary>
<br>

~~~md
{
"Code": 200,
"Message": "done!",
"Data": {
"OperationDate": "2022-01-17T16:32:04.673105+02:00",
"OperationID": 8122388,
"OperationStatus": 10,
"URI": "https://stage-mapi.xpaydirect.com/uk/frame/widget/banner-payment",
"uuid": "691fafc9-5d64-46b5-22ba-85ce61cc26be"
},
"KeyAES": "",
"Sign": ""
}
~~~
</details>
:::

:::success
<details>
<summary>Помилка виконання операції</summary>
<br>

~~~md
{
"Code": 200,
"Message": "done",
"Data": {
"OperationID": 111,
"OperationStatus": 21,
"Reason": 3
},
"KeyAES": "",
"Sign": ""
}
~~~
</details>
:::

## Тестові дані

:::info

Для тестування даного запиту застосовуйте параметри **Тестового Партнера**.
Див. деталі підключення у розділі: ["Параметри підключення Тестового Партнера"](https://hackmd.io/kGejjgk0QaiwfpoZFnTadA).

<details>
<summary>Тестовий запит</summary>
<br>

~~~md
{
"Partner": {
"PartnerToken": "72a8ddb8-9145-4a41-af1a-8c48ecaa4be1",
"OperationType": 10015
},
"Data": "{\"Phone\":\"380277777777\",\"Email\":\"[e-mail]\",\"ClientIP\":\"89.68.252.11\",\"FirstName\":\"Грег\",\"LastName\":\"Дженко\",\"MiddleName\":\"Зюбрикович\",\"BrowserFingerprint\":\"86a190af26de3a920c62ea19ba0df3a8\",\"RedirectURL\":\"https://partner.com/callback/xpay1\",\"Transaction\":{\"TransactionID\":\"0c5328f5-bda9-4376-b6a0-ca544fcb57fc\",\"TerminalID\":\"1\",\"DateTime\":\"2023041812:09:20\"}}",
"KeyAES": "",
"Sign": ""
}
~~~
</details>

<details>
<summary>Очікувана відповідь</summary>
<br>

~~~md
{
"Code": 200,
"Message": "done!",
"Data": {
"OperationDate": "2023-04-18T13:11:51.954491+03:00",
"OperationID": 9508340,
"OperationStatus": 10,
"URI": "https://stage-mapi.xpaydirect.com/uk/frame/widget/banner-payment",
"uuid": "99205abb-2b72-410c-8af8-e92c63bb952c"
},
"KeyAES": "",
"Sign": ""
}
~~~
</details>
:::

## Пов'язані запити

[[20003] Отримання статусу операції](https://hackmd.io/fvd8btZLQXywluia6w5uxg)
[[20007] Отримання даних по клієнту для проходження ідентифікації "BankID/Дія"](https://hackmd.io/2XGUxnOxQyW1wqxMndI_0g)

## Довідкові матеріали

Опис загальних параметрів системи XPAY див. у розділі ["Довідкові матеріали"](https://hackmd.io/aBE7H5cfQ-iqaN3SnwaQ-w): коди типів операцій, типи платіжних методів, коди статусів обробки операцій, відомості та помилки, що повертаються у відповіді та ін.

:arrow_left: [На Головну](/Mj2ZqCVpSq6A6Jzm6ladlw)
:arrow_left: [Загальна інформація по підключенню (API)](https://hackmd.io/g3cItPVFStez0ql3Xj-2TA)

<details>
<summary>Служба підтримки XPAY</summary>
</br>

Телефон: [phone]
Email: [e-mail]
Telegram: @xpaysupportbot
</details>