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

# [20002] Отримання виписки по гаманцю

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

Запит [20002] застосовується для отримання виписки по гаманцю за вказаний період часу.

## Запит

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

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

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

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

~~~
{
"ID": "",
"DateStart": "",
"DateFinish": "",
"Decrypted":
}
~~~
</details>
:::

| Параметр | Обов'яз-ковість | Тип | Опис |Приклад |
|:----:|:----:|:----:|----|:----:|
|`ID`|Так - за наявності декількох гаманців.|Рядок|Унікальний ідентифікатор гаманця у системі Оператора. При порожньому значенні - виписка формується по всім гаманцям Партнера.|`UAH897589401`|
|`DateStart`|Ні|Рядок|Початкова дата періоду виписки у форматі: YYYY-MM-DD 24HH:MM:SS.|`2022-06-20 12:00:00`|
|`DateFinish`|Ні|Рядок|Кінцева дата періоду виписки у форматі: YYYY-MM-DD 24HH:MM:SS.|`2022-06-21 12:00:00`|
|`Decrypted`|Ні|Булевий|Ознака незашифрованості відповіді: </br> `true` - відповідь у незашифрованому вигляді; </br> `false` (значення за замовчуванням) - відповідь у зашифрованому вигляді. |`true`|

## Відповідь

*Загальна інформація по формуванню структури відповіді наведена у розділі [“Загальна інформація по підключенню (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).*

Успішна відповідь на запит [20002] містить масив структур `decodedData`/`encodedData`, у якому передаються незашифровані або зашифровані дані виписки. Параметри структури опціональні та налаштовуються індивідуально в залежності від потреб Партнера.
Основні параметри:

| Параметр | Обов'яз-ковість | Тип | Опис |Приклад|
|:----:|:----:|:----:|----|:----:|
| `Sum` |Ні | Ціле | Сума операції у копійках. |1 грн.=>`100`|
|`State`^1^|Ні|Рядок|Статус операції. Можливі значення див. нижче. |`Done`|
|`DateTime`|Ні|Рядок|Дата та час проведення операції у форматі: YYYY-MM-DD HH24:MM:SS.|`2022-07-17T15:54:11+03:00`|
| `FirstName` | Ні | Рядок | Ім'я клієнта. |`Олег`|
| `MiddleName` | Ні | Рядок | По батькові клієнта. |`Михайлович`|
| `LastName` | Ні | Рядок | Прізвище клієнта. |`Подільський`|
| `CellPhone` | Ні | Рядок | Телефон клієнта у форматі: "380ххххххххх". |`380679335544`|
|`TransactionID`|Ні|Рядок|Унікальний ідентифікатор транзакції у системі Оператора.| `10000623751721`|
|`Extterminalid`|Ні|Рядок|Унікальний ідентифікатор терміналу у системі Партнера.|`11`|
|`Exttransactionid`|Ні|Рядок|Унікальний ідентифікатор транзакції у системі Партнера.|`14588`|
|`SenderWalletID`|Ні|Рядок|Унікальний ідентифікатор гаманця відправника у системі Оператора. |`UAH703758543`|
|`RecipientWalletID`|Ні|Рядок|Унікальний ідентифікатор гаманця одержувача у системі Оператора.|`UAH271057865`|

^1^ Можливі значення параметра **"State"**:

|Статус операції|Фінальність|Результат|
|:----:|:----:|:----:|
|`Created`|Ні|Створена.|
|`Processed`|Ні|В процесі.|
|`Done`|Так|Проведена.|
|`Declined`|Так|Не проведена.|
|`Canceled`|Так|Скасована.|

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

:::success
<details>
<summary>Формування виписки по гаманцю у незашифрованому вигляді</summary>
<br>

~~~md
{
"Code": 200,
"Message": "done",
"Data": {
"OperationDate": "2022-07-19T09:22:11.625775+03:00",
"OperationID": 71637250,
"OperationStatus": 10,
"decodedData": "[{\"Sum\": 33912, \"State\": \"Done\", \"BankDate\": \"2022-07-18T07:41:59.649326+03:00\", \"DateTime\": \"2022-07-17T15:54:11+03:00\", \"LastName\": \"1\", \"CellPhone\": \"390953020919\", \"FirstName\": \"X\", \"Extterminalid\": \"11\", \"TransactionID\": \"10000623751721\", \"SenderWalletID\": \"UAH423159687\", \"Exttransactionid\": \"92fe0186-ae57-449e-ac41-51e35d1152a8\", \"RecipientWalletID\": \"UAH979602379\"}, {\"Sum\": 20000, \"State\": \"Done\", \"BankDate\": \"2022-07-18T07:41:59.649326+03:00\", \"DateTime\": \"2022-07-17T15:54:05+03:00\", \"LastName\": \"1\", \"CellPhone\": \"390953020919\", \"FirstName\": \"X\", \"Extterminalid\": \"1\", \"TransactionID\": \"10000166351711\", \"SenderWalletID\": \"UAH423159687\", \"Exttransactionid\": \"491cf229-37be-49a4-add2-f5cd33352193\", \"RecipientWalletID\": \"UAH885380155\"}, {\"Sum\": 34488, \"State\": \"Done\", \"BankDate\": \"2022-07-18T07:41:59.649326+03:00\", \"DateTime\": \"2022-07-17T14:57:31+03:00\", \"LastName\": \"1\", \"CellPhone\": \"390953020919\", \"FirstName\": \"X\", \"Extterminalid\": \"8\", \"TransactionID\": \"10000547751719\", \"SenderWalletID\": \"UAH423159687\", \"Exttransactionid\": \"63fdfbe3-8f0f-4c65-855c-7eccaabcbbbf\", \"RecipientWalletID\": \"UAH531753698\"}]"
},
"KeyAES": "",
"Sign": ""
}
~~~
</details>
:::

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

:::info

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

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

~~~md
{
"Partner": {
"PartnerToken": "72a8ddb8-9145-4a41-af1a-8c48ecaa4be1",
"OperationType": 20002
},
"Data": "{\"ID\":\"UAH897589401\",\"DateStart\":\"20230305\",\"DateFinish\":\"20230405\",\"Decrypted\":true}",
"KeyAES": "",
"Sign": ""
}
~~~
</details>

<details>
<summary>Очікувана відповідь для "decrypted":"true"</summary>
<br>

~~~md
{
"Code": 200,
"Message": "done",
"Data": {
"OperationDate": "2023-04-05T14:54:06.162928+03:00",
"OperationID": 9505440,
"OperationStatus": 10,
"decodedData": ""
},
"KeyAES": "",
"Sign": ""
}
~~~
</details>

<details>
<summary>Очікувана відповідь для "decrypted":"false"</summary>
<br>

~~~md
{
"Code": 200,
"Message": "done",
"Data": {
"OperationDate": "2023-04-05T14:55:32.170493+03:00",
"OperationID": 9505446,
"OperationStatus": 10,
"encodedData": "fGFnP5E4A6CdtcxjR52wr4D+89M+MMiCrKqdQ1VXCSo="
},
"KeyAES": "dxvau+bYT3LNhDs6yFQ5NSUdNJqMonookGAEZE7mynQvPU0veTE9I77BPEWU9smPS6jrxXap43fmVvtddesJqaUIP+cVEjITmLKX+MV/B/ygmw3iPCBFu6jnv9Yjl7JHx7dPI1vPrTcFFI0437EvkvhIEdRpXKBF0qMzDDk/ogHWnLYBN4yMdA/27nKK32YCLm21FPg5XaVJylBmdGuqV09v0wH/RYFrrnnkIkV9NmPzy7e6ZFwYJC5aDBLb3M5rYDGhbZ08STJ4XGm2uz83Uwl9XT9mT4Kex10Kra+Sj7g4VdCPexkSES2eZ3lV8/3+0qzXPVwOZRbt6ofu7Qrc3g==",
"Sign": "w/1vVGF+U+x73Od3/C8nkTbfNjsMGfkEr0hmLlx1GBfEnN3wB4lFmXf53ZyzMsujGkWkj7GwC7jz3zYDt8lBJyDnUWwE4EYsxUqy5ZOaJ1PDRLk0hSuPV/Sw+rVt7MbbB3tP4GSMpQIOW4+zWglHaEsiCZyyTYoiSxye0P61iuOej1yXWauXE+E3VuTXCARFL8jFxcjAoGVpQbHMBidPSaXn0OCN/oP8OWz3xU4p2fxCIImcpF/8/I5ddO9vJVDUirkt05ViDeq5/CAGHsG81CQ7HWq+LAP3k7LgpXq/g+fZcyBY9Wr8d7VTkcy3MXeOE17LVMjKiXKvRd0k2NzzPQ=="
}
~~~
</details>
:::

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

[[20001] Отримання балансу гаманця](https://hackmd.io/c-2sDICDRGeplJ-QL8bETw)
[[20003] Отримання статусу операції](https://hackmd.io/fvd8btZLQXywluia6w5uxg)
[[20004] Отримання квитанції по операції](https://hackmd.io/mOA9rZ_xSxWrNZxKzvZ5HQ)
[[20008] Отримання курсу валют](https://hackmd.io/inushlCxQa2f0MRgvVD7eg)
[[20009] Отримання ліміту по операції [10101]](https://hackmd.io/a_-XSuzvRvG9t9cU2yoUvg)
[[20110] Отримання даних карти](https://hackmd.io/zFCegCSASKKjGCmoJkTYmw)

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

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