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

# [30201/302013/302015] Відміна/повернення платежу, здійсненого через запити [10102/101023/101025]

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

|"OperationType"| Тип операції |
|:----:|----|
|`30201`| Відміна/повернення платежу, здійсненого через запит [[10102]](https://hackmd.io/jxzgAy4nSt-Q-6chgRCZdQ).|
|`302013`| Відміна/повернення платежу, здійсненого через запит [[101023]](https://hackmd.io/jxzgAy4nSt-Q-6chgRCZdQ).|
|`302015`| Відміна/повернення платежу, здійсненого через запит [[101025]](https://hackmd.io/jxzgAy4nSt-Q-6chgRCZdQ).|

## Запит

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

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

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

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

~~~md
{
"OperationID": ,
"Sum": ,
"ticket": [],
"cashiersignature": "",
"MIDs": [
{
"MID": ,
"Sum": ,
"PaymentInfo": [
{
"Caption": "",
"Value": ""
}
],
"Account": "",
"EDRPOU": "",
"MFO": "",
"Name": ""
}
],
"Transaction":{
"TransactionID": "",
"TerminalID": "",
"DateTime": ""
}
}
~~~
</details>
:::

| Параметр | Обов'язковість | Тип | Опис | Приклад|
|:----:|:----:|:----:|----|:----:|
|`OperationID`|Так|Ціле (для [302013] може передаватись як строка) |Унікальний ідентифікатор операції у системі Оператора, що потребує повернення.|`4576`|
|`Sum`|Ні|Ціле|Загальна сума повернення у копійках. При відсутності параметра сума повернення дорівнює сумі списання.|1грн.=>`100`|
| `MIDs`^1^ | Ні - для [30201]; Так - для **[302013/302015]** | Масив | Масив, що передає дані для розщеплення прийнятого платежу на користь мерчантів. |Див. приклад нижче.|
|`Transaction`|Так|Структура|Структура, що передає дані про транзакцію. Див. розділ ["Структура "Transaction"](https://hackmd.io/g3cItPVFStez0ql3Xj-2TA#2-Data).|Див. нижче.|

*Параметри `ticket` та `cashiersignature`, що передаються за необхідності фіскалізації операції, описані в запиті [[10005]](https://hackmd.io/1okrbJtPTVCsl6b_lyt9bg).*

^1^ Параметри масиву **"MIDs"**:

| Параметр | Обов’яз-ковість | Тип | Опис | Приклад |
|:-:|:-:|:-:|-|:-:|
| `MID` |Так| Ціле | Ідентифікатор мерчанта в системі Оператора (Merchant ID). |`111`|
| `Sum` |Так| Ціле | Сума платежу у копійках.|1грн.=>`100` |
| `PaymentInfo`^2^ | Ні | Масив | Параметр передається для відображення деталей платежу на сторінці оплати. |Див. приклад нижче.|
| `Account` |Ні| Рядок | Розрахунковий рахунок або IBAN одержувача (міжнародний номер банківського рахунку). | `UA4830529900000 26008031203677`|
|`EDRPOU`|Ні|Рядок | [ЄДРПОУ](https://uk.wikipedia.org/wiki/%D0%84%D0%B4%D0%B8%D0%BD%D0%B8%D0%B9_%D0%B4%D0%B5%D1%80%D0%B6%D0%B0%D0%B2%D0%BD%D0%B8%D0%B9_%D1%80%D0%B5%D1%94%D1%81%D1%82%D1%80_%D0%BF%D1%96%D0%B4%D0%BF%D1%80%D0%B8%D1%94%D0%BC%D1%81%D1%82%D0%B2_%D1%82%D0%B0_%D0%BE%D1%80%D0%B3%D0%B0%D0%BD%D1%96%D0%B7%D0%B0%D1%86%D1%96%D0%B9_%D0%A3%D0%BA%D1%80%D0%B0%D1%97%D0%BD%D0%B8) одержувача.|`3505506226` |
| `MFO` |Ні |Рядок | [МФО](https://uk.wikipedia.org/wiki/%D0%9C%D0%A4%D0%9E) - код банку одержувача. |`305299`|
| `Name` | Ні | Рядок | Назва одержувача. |`ТОВ "Ресурс"`|

^2^ Параметри масиву **"PaymentInfo"**:

| Параметр | Обов’яз-ковість | Тип | Опис | Приклад |
|:-:|:-:|:-:|-|:-:|
| `Caption` |Так| Рядок | Опис додаткової інформації. |`Призначення`|
| `Value` |Так| Рядок | Додаткова інформація. |`Погашення за контрактом №3642989012-5 від 03.04.2021 Пупкіна Валерія Сергіївна`|

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

~~~md
{
"Sum": 3000,
"ticket": [
{
"ID": "РД009732",
"Good": "Сметана 20% жиру ТМ Простоквашино 350г/20",
"Count": 1000,
"Price": 3000,
"uktzed": "0403"
}
],
"MIDs": [
{
"MID": 111,
"PaymentInfo": [
{
"Caption": "Призначення",
"Value": "Погашення за контрактом №3642989012-5 від 03.04.2021 Пупкіна Валерія Сергіївна"
}
],
"Sum": 100,
"Account": "UA483052990000000008031203000",
"EDRPOU": "3505501111",
"MFO": "123456"
},
{
"MID": 112,
"PaymentInfo": [
{
"Caption": "Призначення",
"Value": "Погашення за контрактом №3642989012-5 від 03.04.2021 Пупкіна Валерія Сергіївна"
}
],
"Sum": 200,
"Account": "UA483052990000000008031203000",
"EDRPOU": "3505501111",
"MFO": "123456"
}
],
"OperationID": 54142896,
"Transaction": {
"TransactionID": "321643_1643975265",
"TerminalID": "1",
"DateTime": "20220406 08:07:09"
}
}
~~~
</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>Операція проведена успішно</summary>
<br>

~~~md
{
"Code": 200,
"Message": "operation ok",
"Data": {
"OperationID": 4576,
"OperationStatus": 10
},
"KeyAES": "",
"Sign": ""
}
~~~
</details>
:::

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

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

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

:::warning
*!! Не актуально (додано масив `MIDs`)*


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

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

~~~md
{
"Partner": {
"PartnerToken": "72a8ddb8-9145-4a41-af1a-8c48ecaa4be1",
"OperationType": 30201
},
"Data": "{\"OperationID\":4576,\"Sum\":16200,\"ticket\":[],\"cashiersignature\":\"\",\"Transaction\":{\"TransactionID\":\"321643_1643975265\",\"TerminalID\":\"1\",\"DateTime\":\"2023041810:47:31\"}}",
"KeyAES": "",
"Sign": ""
}
~~~
</details>

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

~~~md
{
"Code": 200,
"Message": "Done",
"Data": {
"OperationDate": "2023-04-18T11:59:57.461895+03:00",
"OperationID": 9508323,
"OperationStatus": 10
},
"KeyAES": "",
"Sign": ""
}
~~~
</details>
:::

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

[[10001/10002] Підтвердження/скасування передавторизації, здійсненої через запити [10102/101023/101025]](https://hackmd.io/KRcEsWMkRtiV0T1_ISoUMA)
[[102070221/102070222/102070251/102070252] Підтвердження/скасування передавторизації](https://hackmd.io/aTXOGiPaSkewvXdXUbpstg)
[[30202] Відміна/повернення платежу поставторизації](https://hackmd.io/YQp1wWGTTCmw0EG_zFGIwg)
[[30203] Відміна/повернення платежу, здійсненого через Checkout](https://hackmd.io/3BzRqynvSF-J7fhcZCZDXA)

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

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