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

# [20007] Отримання даних по клієнту для проходження ідентифікації "BankID/Дія"

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

Запит [20007] застосовується для отримання персональних даних по клієнту для проходження ідентифікації "[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))".

## Запит

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

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

Структура "Data" для даної операції формується з наступних параметрів:

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

~~~
{
"UserID": "",
"Phone": "",
"Email": "",
"Transaction": {
"TransactionID": "",
"TerminalID": "",
"DateTime": ""
}
}
~~~
</details>
:::

| Параметр | Обов'яз-ковість | Тип | Опис |Приклад|
|:----:|:----:|:----:|----|:----:|
| `UserID` | Так | Рядок | Унікальний ідентифікатор клієнта у системі Партнера. |`380932799111`|
| `Phone` | Ні | Рядок | Телефон клієнта у форматі: "380ххххххххх". |`380679335544`|
| `Email` | Ні | Рядок | Email клієнта. |`[e-mail]`|
|`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"

Успішна відповідь на запит [20007] містить структуру `UserProfile`, у якій передаються персональні дані по клієнту. Всі параметри даної структури опціональні та налаштовуються індивідуально в залежності від типу операції та потреб Партнера.

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

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

~~~md
{
"Code": 200,
"Message": "Done",
"Data": {
"OperationStatus": 10,
"UserProfile": {
"email": null,
"bankid": null,
"user_id": 96169,
"last_name": "Мазур",
"cell_phone": "380688101893",
"first_name": "Олег",
"middle_name": ""
}
},
"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": 20007
},
"Data": "{\"UserID\":\"380277777777\",\"Phone\":\"380277777777\",\"Email\":\"[e-mail]\",\"Transaction\":{\"TransactionID\":\"0c5328f5-bda9-4376-b6a0-ca544fcb61fc\",\"TerminalID\":\"1\",\"DateTime\":\"2023041812:19:20\"}}",
"KeyAES": "",
"Sign": ""
}
~~~
</details>

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

~~~md

~~~
</details>
:::

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

[[10015/10025/10035/10045] Отримання посилання віджета для проходження ідентифікації "BankID/Дія"](https://hackmd.io/EimWFyvOSxSEqZiABDIUtg)
[[20003] Отримання статусу операції](https://hackmd.io/fvd8btZLQXywluia6w5uxg)

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

Опис загальних параметрів системи 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>