УКР | [ENG](https://hackmd.io/N6l7JmtQQ4mVtAl-2GebOw)
:arrow_left: [На Головну](/eSq3juGWQLS1wVvJZiTUAQ)

# [40403] Платіжний інструмент-IBAN

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

Запит [40403] застосовується для виконання платежу з платіжного інструменту на вказані реквізити (IBAN).

Схему взаємодії див. у розділі "[Загальна схема взаємодії](https://hackmd.io/Q5OrcottRSKWlfrPZPC7mg)".

## Запит

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

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

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

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

~~~
{
"UserID": "",
"Phone": "",
"Email": "",
"DeviceID": "",
"Sum": ,
"Sender": "",
"Recipient": "",
"CallbackURL": "",
"Bunch": [
{
"Sum":,
"RecipientWalletID": ""
}
],
"Transaction": {
"TransactionID": "",
"TerminalID": "",
"DateTime": ""
}
}
~~~
</details>
:::

| Параметр | Обов'яз-ковість | Тип | Опис | Приклад|
|:----:|:----:|:----:|----|:----:|
|`UserID`|Ні |Рядок|Унікальний ідентифікатор клієнта у системі Партнера.|`Uwuh0B5GQVuokYSL`|
| `Phone` | Так | Рядок | Телефон клієнта у форматі "380ххххххххх". |`380679335544`|
| `Email` | Ні | Рядок | Email клієнта. |`[e-mail]`|
|`DeviceID`| Так |Рядок| ID пристрою клієнта. Для web-застосунків використовується "fingerprint", для мобільних застосунків - ["DeviceID"](https://support.google.com/google-ads/answer/9004555?hl=en).|`0Ht9z0yh5aDNr5-js1zGFz5QTmIE=`|
| `Sum` | Так | Ціле | Сума операції у копійках. |1грн.=>`100`|
| `Sender` | Так | Рядок | UUID (унікальний ідентифікатор) платіжного інструменту відправника. |`ead5ea7a-f19f-44ec-8742-3621b4bfdc18`|
| `Recipient`^1^| Так | Структура | Структура, що передає дані банківського рахунку одержувача. |`380639917543`|
| `CallbackURL` | Ні | Рядок | URL адреса, на яку буде перенаправлений клієнт після завершення оплати.| `https://partner.com/result_page`|
|`Bunch`^2^|Так|Масив|Масив структур, що передає дані додаткових виплат.|Див. нижче.|
|`Transaction`|Так|Структура|Структура, що передає дані про транзакцію. Див. розділ ["Структура "Transaction"](https://hackmd.io/g3cItPVFStez0ql3Xj-2TA#2-Data).|Див. нижче.|

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

| Параметр | Обов'яз-ковість | Тип | Опис | Приклад|
|:----:|:----:|:----:|----|:----:|
| `MFO` |Ні |Рядок | [МФО](https://uk.wikipedia.org/wiki/%D0%9C%D0%A4%D0%9E) - код банку. |`305299`|
|`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` |
| `Account` |Так| Рядок | Розрахунковий рахунок або IBAN одержувача (міжнародний номер банківського рахунку). | `UA4830529900000-26008031203677`|
| `Purpose` |Ні|Рядок|Призначення платежу.|`Переказ коштiв №1178341032 від КАТЕРИНА ХОМЧЕНКО`|
|`SenderName`|Ні|Рядок|ПІБ відправника.|`КАТЕРИНА ХОМЧЕНКО`|
|`RecipientName`|Ні|Рядок|ПІБ/найменування одержувача.|`Катерина`|

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

| Параметр | Обов'яз-ковість | Тип | Опис | Приклад|
|:----:|:----:|:----:|----|:----:|
| `Sum` | Так | Ціле | Сума виплат у копійках. |1грн.=>`100`|
|`RecipientWalletID`|Так|Рядок|Ідентифікатор гаманця одержувача, яким може виступати: </br> - номер телефону, </br> - email, </br> - унікальний ідентифікатор клієнта в системі Партнера, </br> - номер картки клієнта.| `[e-mail]`|

:::success
<details>
<summary>Приклад запиту [40403]</summary>
<br>

~~~md
{
"Partner": {
"Locale": "uk",
"PartnerToken": "dc53e8b4-0648-4cbd-86ac-a17ed0b702af",
"OperationType": 40403
},
"Data": "{\"Sum\": 100, \"Email\": \"[e-mail]\", \"Phone\": \"380678897193\", \"Sender\": \"43917a4b-1a70-403c-9589-a9df4cff114f\", \"DeviceID\": \"c32d3a1128f00730\", \"Recipient\": \"{\"Account\": \"UA483052990000026008031203677\", \"EDRPOU\": \"41916045\", \"MFO\": \"300465\", \"Purpose\": \"Переказ коштiв №1178341032 від КАТЕРИНА ХОМЧЕНКО\", \"RecipientName\": \"Катерина\", \"SenderName\": \"КАТЕРИНА ХОМЧЕНКО\"}\", \"Transaction\": {\"DateTime\": \"20200706 15:49:59\", \"TerminalID\": \"32\", \"TransactionID\": \"2d4d425a4146774c57706f6336695f7a6c496f44\"}}",
"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).*

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

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

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

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

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

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

Опис загальних параметрів системи XPAY див. у розділі ["Довідкові матеріали"](https://hackmd.io/aBE7H5cfQ-iqaN3SnwaQ-w): коди типів операцій, типи платіжних методів, коди статусів обробки операцій, відомості та помилки, що повертаються у відповіді та ін.

:arrow_left: [На Головну](/eSq3juGWQLS1wVvJZiTUAQ)
:arrow_left: [Загальна інформація по підключенню (API)](https://hackmd.io/g3cItPVFStez0ql3Xj-2TA)

<details>
<summary>Служба підтримки XPAY</summary>
</br>

Телефон: [phone]
Email: [e-mail]
Telegram: @xpaysupportbot
</details>