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

# [20802] Отримання даних заборгованості (v.1)

:::info
Застосування версії запитів "Оплата комунальних послуг (v.1)" чи "Оплата комунальних послуг (v.2)" визначається на етапі інтеграції.
:::

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

Запит [20802] застосовується для отримання даних заборгованості по окремому акаунту.

## Запит

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

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

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

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

~~~
{
"accountid": "",
"Transaction": {
"TransactionID": "",
"TerminalID": "",
"DateTime": ""
}
}
~~~
</details>
:::

|Параметр|Обов'яз-ковість|Тип|Опис|Приклад|
|:----:|:----:|:----:|----|:----:|
| `accountid` | Так | Рядок | Унікальний ідентифікатор акаунту, отриманий у відповіді на запит [[20801]](https://hackmd.io/Xndoh9TxRPSMk1V1pPhXUQ). |`17`|
|`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"

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

| Параметр | Обов’яз-ковість | Тип | Опис | Приклад |
|:-:|:-:|:-:|-|:-:|
| `ID_PLAT_KLIENT` | Так | Ціле | Унікальний ідентифікатор платника послуг. |`383064108`|
| `KOMIS` | Так | Масив | Масив структур, що передає дані сум комісії. |Див. нижче.|
| `PLATS` | Так | Масив | Масив структур, що передає дані по заборгованості. Параметри кожної структури опціональні та налаштовуються індивідуально в залежності від типу платежу та потреб Партнера. |Див. нижче.|

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

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

~~~md
{
"Code": 200,
"Message": "Done",
"Data": {
"ID_PLAT_KLIENT": 383064108,
"KOMIS": [
{
"SUM": 0
}
],
"PLATS": [
{
"ID_PLAT_PLAT": 339506757008,
"FIRME": "ТОВ \"ЄВРО-РЕКОНСТРУКЦIЯ\"",
"SERVICE_LABEL": "АП (абонентська плата)",
"ABCOUNT": "1*34",
"SUMM": 303.08,
"DTIME": "2022-06-23T12:39:45Z",
"MONEY_ID": 0,
"COUNTERS": null
},
{
"ID_PLAT_PLAT": 339506756908,
"FIRME": "ТОВ \"ЄВРО-РЕКОНСТРУКЦIЯ\"",
"SERVICE_LABEL": "ЦЕНТРАЛІЗОВАНЕ ПОСТАЧАННЯ ГАРЯЧОЇ ВОДИ",
"ABCOUNT": "1*34",
"SUMM": 16511.68,
"DTIME": "2022-06-23T12:39:45Z",
"MONEY_ID": 0,
"COUNTERS": [
{
"ID_PLAT_COUNTERS": 14788381901,
"NCOUNTERS": 1,
"OLD_VAL": 0,
"NEW_VAL": 0
}
]
}
]
}
}
~~~
</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": 20802
},
"Data": "{\"accountid\":\"77209001\",\"Transaction\":{\"TransactionID\":\"0c5328f5-bda9-4376-b6a0-ca544fcb74fc\",\"TerminalID\":\"1\",\"DateTime\":\"20230221120724\"}}",
"KeyAES": "",
"Sign": ""
}
~~~
</details>

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

~~~md
{
"Code": 200,
"Message": "Payment request success",
"Data": {
"ERR": 0,
"KOMIS": null,
"OperationDate": "2023-04-19T13:35:33.763504+03:00",
"OperationID": 9508523,
"OperationStatus": 10,
"PLATS": null,
"payment": {
"IBAN": "UA743288450000026032320524233",
"name": "Одеський ГЕРЦ",
"recipient": "Центральний міський підрозділ ТОВ \"ООЕК\""
}
},
"KeyAES": "",
"Sign": ""
}
~~~
</details>
:::

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

[[20801] Отримання даних довідника](https://hackmd.io/Xndoh9TxRPSMk1V1pPhXUQ)
[[208011] Отримання даних міст з довідника](https://hackmd.io/qckJ3sUqT5C00IvWxsJ4dw)
[[10108] Погашення заборгованості](https://hackmd.io/f8cr3qN-QU27s2pAyU39bQ)

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

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