owned this note
owned this note
Published
Linked with GitHub
УКР | [ENG](https://hackmd.io/AWcnFUssRNGTTPKZ7mrRlg)
![](https://i.imgur.com/ULmPUgP.jpg)
:arrow_left: [На Головну](/Mj2ZqCVpSq6A6Jzm6ladlw)
# [80200] Отримання інформації по штрафам
## Застосування
Запит [80200] застосовується для отримання детальної інформації по штрафам клієнта.
## Запит
*Опис атрибутів "Partner", "KeyAES" та "Sign" див. у розділі ["Загальна інформація по підключенню (API)"](https://hackmd.io/g3cItPVFStez0ql3Xj-2TA).*
### Структура "Data"
Для отримання інформації по штрафам у структурі "Data" необхідно передати наступні параметри:
1. *АБО дані посвідчення водія:*
:::info
<details>
<summary>1. Формування структури "Data" (приклади наведені нижче)</summary>
<br>
~~~
{
"LicenseSeries": "",
"LicenseNumber": "",
"LicenseDate": "",
"Transaction": {
"TransactionID": "",
"TerminalID": "",
"DateTime": ""
}
}
~~~
</details>
:::
| Параметр | Обов'яз-ковість | Тип | Опис |Приклад|
|:----:|:----:|:----:|----|:----:|
|`LicenseSeries`|Так|Рядок|Серія посвідчення водія.|`ООО`|
|`LicenseNumber`|Так|Рядок|Номер посвідчення водія.|`321456`|
|`LicenseDate`|Так|Рядок|Дата видачі посвідчення водія у форматі: YYYY-MM-DD.|`2015-05-05`|
|`Transaction`|Так|Структура|Структура, що передає дані про транзакцію. Див. розділ ["Структура "Transaction"](https://hackmd.io/g3cItPVFStez0ql3Xj-2TA#2-Data).|Див. нижче.|
2. *АБО дані паспорта/ID-карти (одне з двох) та номерний знак транспортного засобу (ТЗ)*:
:::info
<details>
<summary>2. Формування структури "Data" (приклади наведені нижче)</summary>
<br>
~~~
{
"PassportSeries": "",
"PassportNumber": "",
"IDcardNumber": "",
"RegPlate": "",
"Transaction": {
"TransactionID": "",
"TerminalID": "",
"DateTime": ""
}
}
~~~
</details>
:::
| Параметр | Обов'яз-ковість | Тип | Опис |Приклад|
|:----:|:----:|:----:|----|:----:|
|`PassportSeries`|Так/Ні|Рядок|Серія паспорта.|`АВ`|
|`PassportNumber`|Так/Ні|Рядок|Номер паспорта.|`165433`|
|`IDcardNumber`|Так/Ні|Рядок|Номер ID-картки - унікальний номер запису у реєстрі (УНЗР).| `19910824-00026`|
|`RegPlate`|Так|Рядок|Номерний знак ТЗ.|`АІ1387СК`|
|`Transaction`|Так|Структура|Структура, що передає дані про транзакцію. Див. розділ ["Структура "Transaction"](https://hackmd.io/g3cItPVFStez0ql3Xj-2TA#2-Data).|Див. нижче.|
3. *АБО дані постанови та номерний знак транспортного засобу (ТЗ):*
:::info
<details>
<summary>3. Формування структури "Data" (приклади наведені нижче)</summary>
<br>
~~~
{
"ResolutionSeries": "",
"ResolutionNumber": "",
"RegPlate": "",
"Transaction": {
"TransactionID": "",
"TerminalID": "",
"DateTime": ""
}
}
~~~
</details>
:::
| Параметр | Обов'яз-ковість | Тип | Опис |Приклад|
|:----:|:----:|:----:|----|:----:|
|`ResolutionSeries`|Так|Рядок|Серія постанови.| `АР`|
|`ResolutionNumber`|Так|Рядок|Номер постанови.| `123456`|
|`RegPlate`|Так|Рядок|Номерний знак ТЗ.|`АІ1387СК`|
|`Transaction`|Так|Структура|Структура, що передає дані про транзакцію. Див. розділ ["Структура "Transaction"](https://hackmd.io/g3cItPVFStez0ql3Xj-2TA#2-Data).|Див. нижче.|
:::success
<details>
<summary>Приклад запиту [80200] (дані посвідчення водія)</summary>
<br>
~~~md
{
"Partner": {
"PartnerToken": "72a8ddb8-9145-4a41-af1a-8c48ecaa4be1",
"OperationType": 80200
},
"Data": "{\"LicenseSeries\":\"ООО\",\"LicenseNumber\":\"321456\",\"LicenseDate\":\"2015-05-05\",\"Transaction\ ":{\"TransactionID\":\"321466\",\"TerminalID\":\"1\",\"DateTime\":\"2019-02-11 13:37:17\"}}" ,
"KeyAES": "",
"Sign": ""
}
~~~
</details>
:::
## Відповідь
*Загальна інформація по формуванню структури відповіді наведена у розділі [“Загальна інформація по підключенню (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).*
Успішна відповідь на запит [80200] містить масив структур `Fines`, у якому передаються дані по запитаним штрафам:
| Параметр | Обов'яз-ковість | Тип | Опис |Приклад|
|:----:|:----:|:----:|----|:----:|
| `Department`|Ні | Рядок | Департамент поліції, що оформляв протокол. |`УПРАВЛІННЯ ПАТРУЛЬНОЇ ПОЛІЦІЇ ЛЬВІВСЬКОЇ ОБЛАСТІ`|
| `fab` | Ні| Рядок | Фабула правопорушення. |`М06 508 ПЕРЕТНУВ СУЦІЛЬНУ ЛІНІЮ ДОРОЖНЬОЇ РОЗМІТКИ 1.1`|
| `kupap` |Ні | Рядок | Порушена стаття КоАП (кодекс про адміністративні правопорушення). |`СТ.122 Ч.1 Перевищення водіями ТЗ встановлених обмежень шв.руху та порушення інших ПДР`|
| `region` | Ні| Рядок | Область. | `ЛЬВІВСЬКА`|
| `district` |Ні | Рядок | Район.| `БУСЬКИЙ`|
| `city` |Ні | Рядок | Місто. | `ЛЬВІВ`|
| `street` |Ні | Рядок | Вулиця. | `МИРНА`|
| `roadKm` | Ні| Рядок | Кілометр дороги, де створено правопорушення. | `17`|
| `send` | Ні| Рядок | Куди направлено протокол до розгляду. | `Сихівський районний суд м.Львова`|
| `consider` |Ні | Рядок | Хто розглянув. |`Борачок М.В.`|
| `decision` |Ні | Рядок | Рішення. | `НАКЛАДЕНО СТЯГНЕННЯ ЗА СТ.КУПАП`|
| `penalty` |Ні| Рядок | Вид покарання. | `ШТРАФ`|
| `sumFine` |Ні | Рядок | Сума штрафу. |`255`|
| `sumPenalty` | Ні| Рядок | Сума стягнення. | `255`|
| `paidPenalty` | Ні| Рядок | Сплачена сума штрафу. |`255` |
| `licensePlate` |Ні | Рядок | Номерний знак транспортного засобу. |`АІ1387СК`|
| `brand` |Ні | Рядок | Марка та модель транспортного засобу. |`KIA SOUL`|
| `pdd` | Ні| Рядок | Порушена стаття ПДР. |`п.8.5.1.ПДР - Порушення вимог горизонтальної дорожньої розмітки` |
| `mark` |Ні | Рядок | Примітки до протоколу. |`<Примітки>`|
| `drecord` |Ні | Рядок | Дата запису у БД. |`2019-06-23T00:00:00` |
| `dsignPost` |Ні | Рядок | Дата створення протоколу.|`2019-06-23T00:00:00` |
| `dperpetration` |Ні | Рядок | Дата вчинення правопорушення. | `2019-06-23T00:00:00`|
| `dateDelivery` | Ні| Рядок | Дата вручення. |`2019-06-23T00:00:00`|
| `dsend` | Ні| Рядок | Дата надсилання протоколу. |`2019-06-23T00:00:00` |
| `ddecision` | Ні| Рядок | Дата винесення рішення. |`2019-06-23T00:00:00`|
| `dpaid` | Ні| Рядок | Дата сплати. |`2019-07-02T00:00:00`|
| `dcanceled` | Ні| Рядок | Дата скасування рішення. |`2019-10-02T00:00:00`|
| `sprotocol` |Ні | Рядок | Серія протоколу. |`ЕАВ`|
| `nprotocol` |Ні | Рядок | Номер протоколу. | `1258836`|
|`sdecree`|Ні | Рядок | Серія постанови. |`АСДК`|
|`ndecree`|Ні | Рядок | Номер постанови.|`103437587`|
| `paidinfo` |Ні | Рядок | Реквізити оплати штрафу. |`UA088999980333209397000026001` |
| `docId` | Ні| Рядок |Унікальний ідентифікатор штрафу. |`30191745443969447370`|
| `typeFine`|Ні| Ціле | Тип штрафу: </br> `1` - звичайний, </br> `2` - фотофіксація, </br> `3` – паркування. |`1`|
| `payStatus` | Ні|Ціле | Статус сплати штрафу: </br> `0` - не сплачено, </br> `1` - сплачено, </br> `2` – погашено.|`2`|
### Приклади відповідей
:::success
<details>
<summary>Операція проведена успішно</summary>
<br>
~~~md
{
"Code": 200,
"Message": "done",
"Data": {
"Fines": [
{
"CanPay": false,
"brand": "KIA SOUL",
"city": null,
"consider": "Борачок М.В.",
"dateDelivery": null,
"dcanceled": null,
"ddecision": "2019-06-23T00:00:00",
"decision": "НАКЛАДЕНО СТЯГНЕННЯ ЗА СТ.КУПАП",
"department": "УПРАВЛІННЯ ПАТРУЛЬНОЇ ПОЛІЦІЇ ЛЬВІВСЬКОЇ ОБЛАСТІ",
"district": "БУСЬКИЙ",
"docId": "30191745443969447370",
"dpaid": "2019-07-02T00:00:00",
"dperpetration": "2019-06-23T00:00:00",
"drecord": "2019-06-23T00:00:00",
"dsend": null,
"dsignPost": "2019-06-23T00:00:00",
"fab": "М06 508 ПЕРЕТНУВ СУЦІЛЬНУ ЛІНІЮ ДОРОЖНЬОЇ РОЗМІТКИ 1.1",
"kupap": "СТ.122 Ч.1 Перевищення водіями т\\з встановлених обмежень шв.руху та порушення інших ПДР",
"licensePlate": "АІ1387СК",
"mark": null,
"ndecree": null,
"nprotocol": "1258836",
"paidPenalty": "255",
"paidinfo": null,
"payStatus": 2,
"pdd": "п.8.5.1.ПДР - Порушення вимог горизонтальної дорожньої розмітки",
"penalty": "ШТРАФ",
"region": "ЛЬВІВСЬКА",
"roadKm": null,
"sdecree": null,
"send": "НЕ НАПРАВЛЯВСЯ",
"sprotocol": "ЕАВ",
"status": null,
"street": "МИРНА",
"sumFine": "255",
"sumPenalty": "255",
"typeFine": 1
}
],
"OperationStatus": 10
},
"KeyAES": "",
"Sign": ""
}
~~~
</details>
:::
:::success
<details>
<summary>Помилка виконання операції</summary>
<br>
~~~md
{
"Code": 200,
"Message": "done",
"Data": {
"OperationID": 111,
"OperationStatus": 21
},
"KeyAES": "",
"Sign": ""
}
~~~
</details>
:::
## Тестові дані
:::info
![](https://i.imgur.com/gtxKB22.png)
Для тестування даного запиту застосовуйте параметри **Тестового Партнера**.
Див. деталі підключення у розділі: ["Параметри підключення Тестового Партнера"](https://hackmd.io/kGejjgk0QaiwfpoZFnTadA).
<details>
<summary>Тестовий запит</summary>
<br>
~~~md
{
"Partner": {
"PartnerToken": "72a8ddb8-9145-4a41-af1a-8c48ecaa4be1",
"OperationType": 80200
},
"Data": "{\"LicenseSeries\":\"ООО\",\"LicenseNumber\":\"321456\",\"LicenseDate\":\"2015-05-05\",\"Transaction\":{\"TransactionID\":\"0c5328f5-bda9-4376-b6a0-ca544fcb76fc\",\"TerminalID\":\"1\",\"DateTime\":\"20230221122524\"}}",
"KeyAES": "",
"Sign": ""
}
~~~
</details>
<details>
<summary>Очікувана відповідь</summary>
<br>
~~~md
~~~
</details>
:::
## Пов'язані запити
[[80001] Оплата штрафу картою через мобільний додаток](https://hackmd.io/0gQHPa8HTtiltQgi8h9d3A)
[Форма оплати штрафу для Партнерського ресурсу](https://hackmd.io/CQh8x7B0SyWv9L5DnDDF8A)
## Довідкові матеріали
Опис загальних параметрів системи XPAY див. у розділі ["Довідкові матеріали"](https://hackmd.io/aBE7H5cfQ-iqaN3SnwaQ-w): коди типів операцій, типи платіжних методів, коди статусів обробки операцій, відомості та помилки, що повертаються у відповіді та ін.
![](https://i.imgur.com/17gAyWb.png)
:arrow_left: [На Головну](/Mj2ZqCVpSq6A6Jzm6ladlw)
:arrow_left: [Загальна інформація по підключенню (API)](https://hackmd.io/g3cItPVFStez0ql3Xj-2TA)
<details>
<summary>Служба підтримки XPAY</summary>
</br>
Телефон: +38 093 891 92 00
Email: info@xpay.com.ua
Telegram: @xpaysupportbot
</details>