:arrow_left: [На Головну](/Mj2ZqCVpSq6A6Jzm6ladlw)

# [10108] Погашення заборгованості (v.2)

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

*Що таке "оплата картою Server-Server" та як проходить автентифікація відправника див. у розділі ["Оплата картою Server-Server"](https://hackmd.io/oXcYbY08Tq69ggTIX9OyaA).*

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

Запит [10108] застосовується для погашення заборгованості картою на основі даних, отриманих у відповіді на запит [[20802] (v.2)](https://hackmd.io/26l7UwT9TLKlmV9gNconZg).

## Запит

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

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

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

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

~~~
{
"Sum": ,
"SenderCard": {
"PAN": "",
"ExpMon": "",
"ExpYear": "",
"CVV": ""
},
"payments": [
{
"serviceid": "",
"productid": "",
"Sum": ,
"meters": [
{
"id": ,
"oldvalue": ,
"newvalue":
}
]
}
],
"Transaction": {
"TransactionID": "",
"TerminalID": "",
"DateTime": ""
},
"BrowserData": {
"device": {
"channel": ""
},
"browserIP": "",
"browserLanguage": "",
"browserUserAgent": "",
"fraudhuntFingerprint": ""
}
}
~~~
</details>
:::

|Параметр|Обов'яз-ковість|Тип|Опис|Приклад|
|:----:|:----:|:----:|----|:----:|
|`Sum`|Так|Ціле|Загальна сума погашення у копійках. |1грн.=>`100`|
|`SenderCard`^1^|Так|Структура|Структура, що передає дані банківської картки відправника.|Див. нижче.|
|`payments`^2^|Так|Масив|Масив, що передає дані про платника послуг та деталі погашення заборгованості.|Див. нижче.|
|`BrowserData`|Ні|Структура|Структура, що передає дані браузера при *3DSecure 2.0*. Див. розділ ["Структура "BrowserData"](https://hackmd.io/oXcYbY08Tq69ggTIX9OyaA?both#%D0%A1%D1%82%D1%80%D1%83%D0%BA%D1%82%D1%83%D1%80%D0%B0-%E2%80%9CBrowserData%E2%80%9D).|Див. приклад у розділі ["Структура "BrowserData"](https://hackmd.io/oXcYbY08Tq69ggTIX9OyaA?both#%D0%A1%D1%82%D1%80%D1%83%D0%BA%D1%82%D1%83%D1%80%D0%B0-%E2%80%9CBrowserData%E2%80%9D).|
|`Transaction`|Так|Структура|Структура, що передає дані про транзакцію. Див. розділ ["Структура "Transaction"](https://hackmd.io/g3cItPVFStez0ql3Xj-2TA#2-Data).|Див. нижче.|

^1^ Параметри структури **"SenderCard"**:

| Параметр | Обов'яз-ковість | Тип | Опис | Приклад|
|:----:|:----:|:----:|----|:----:|
|`PAN`|Так|Рядок[16]| PAN картки відправника (номер банківської карти).| `8888888888888888` |
|`ExpMon`|Так|Рядок[2]|Місяць терміну дії картки. Параметр вирівнюється до 2-х знаків символом "0".|`02`|
|`ExpYear`|Так|Рядок[2]|Останні 2 цифри року терміну дії картки. Параметр вирівнюється до 2-х знаків символом "0".|`22`|
|`CVV`|Так|Рядок[3]|CVV код картки.|`356`|

^2^ Параметри структури **"payments"**:

| Параметр | Обов'яз-ковість | Тип | Опис | Приклад|
|:----:|:----:|:----:|----|:----:|
| `serviceid` | Так | Рядок | Унікальний ідентифікатор сервісу, отриманий у відповіді на запит [[20801] (v.2)](https://hackmd.io/tWx9osErTZSOWRh2lksgEA): `id`. |`1`|
| `productid` | Так | Рядок |Унікальний ідентифікатор заборгованості, отриманий у відповіді на запит [[20802] (v.2)](https://hackmd.io/26l7UwT9TLKlmV9gNconZg): `productid`. |`383064108`|
|`Sum`|Так|Ціле|Сума погашення у копійках. |1грн.=>`100`|
|`meters`^3^|Ні|Масив | Масив структур, що передає дані лічильників, отримані у відповіді на запит [[20802] (v.2)](https://hackmd.io/26l7UwT9TLKlmV9gNconZg): `Meters`. |Див. нижче.|

^3^ Параметри масиву структур **"meters"**:

| Параметр | Обов'яз-ковість | Тип | Опис | Приклад|
|:----:|:----:|:----:|----|:----:|
| `id` | Так | Ціле | Унікальний ідентифікатор лічильника, отриманий у відповіді на запит [[20802] (v.2)](https://hackmd.io/26l7UwT9TLKlmV9gNconZg). |`14781385901`|
|`oldvalue`|Ні|Ціле| Останнє значення лічильника (може бути пустим), отримане у відповіді на запит [[20802] (v.2)](https://hackmd.io/26l7UwT9TLKlmV9gNconZg). |`1100`|
|`newvalue`|Так|Ціле|Нове значення лічильника. |`1111`|

:::success
<details>
<summary>Приклад структури "Data"</summary>
<br>

~~~md
{
"Sum": 1000,
"SenderCard": {
"PAN": "535124******0453",
"ExpMon": "12",
"ExpYear": "24",
"CVV": "***"
},
"payments": [
{
"serviceid": "1",
"productid": "383064108",
"Sum": 210,
"meters": [
{
"id": 14781385901,
"oldvalue": 0,
"newvalue": 10
}
]
}
],
"Transaction": {
"TransactionID": "0c5328f5-bda9-4376-b6a0-ca544fcb72fc",
"TerminalID": "1",
"DateTime": "20230221120111"
}
}
~~~
</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).*

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

:::success
<details>
<summary>Запит успішно прийнятий та вимагає підтвердження "3DS"</summary>
<br>

~~~md
{
"Code": 102,
"Message": "need3ds",
"Data": {
"OperationID": 111,
"3dsHtml": "<html сторінка у кодуванні base64>",
"OperationStatus": 2
},
"KeyAES": "",
"Sign": ""
}
~~~
</details>
:::

:::success
<details>
<summary>Запит успішно прийнятий та вимагає підтвердження "OTP"</summary>
<br>

~~~md
{
"Code": 102,
"Message": "needOTP",
"Data": {
"OperationID": 111,
"otpJson": "<JSON структура у вигляді рядка>",
"OperationStatus": 3
},
"KeyAES": "",
"Sign": ""
}
~~~
</details>
:::

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

~~~md
{
"Code": 200,
"Message": "Done",
"Data": {
},
"KeyAES": "",
"Sign": ""
}
~~~
</details>
:::

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

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

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

[[20801] Отримання даних довідника (v.2)](https://hackmd.io/tWx9osErTZSOWRh2lksgEA)
[[20802] Отримання даних заборгованості (v.2)](https://hackmd.io/26l7UwT9TLKlmV9gNconZg)

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

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