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

# [10303] Гаманець-IBAN

*Що таке "гаманець XPAY" див. у розділі ["Гаманець XPAY"](https://hackmd.io/JXJaJEcEQeO2fjRgYbxj6w).*

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

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

## Запит

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

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

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

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

~~~
{
"Phone": "",
"Email": "",
"Sum": ,
"Currency": "",
"Exchange": "",
"Purpose": "",
"Sender": {
"MFO": "",
"Name": "",
"EDRPOU": "",
"Account": "",
"CountryResidence": "",
"ActualCountry": "",
"Country": "",
"City": "",
"Street": "",
"Building": ""
},
"Recipient": {
"Name": "",
"MFO": "",
"EDRPOU": "",
"Account": ""
},
"SenderPerson": {
"FirstName": "",
"LastName": "",
"MiddleName": "",
"IPN": "",
"Birthday": "",
"Birthplace": "",
"Phone": "",
"Email": "",
"Address": "",
"City": "",
"CountryCode": "",
"PostCode": "",
"State": ""
},
"RecipientPerson": {
"FirstName": "",
"LastName": "",
"MiddleName": "",
"IPN": "",
"Birthday": "",
"Birthplace": "",
"Address": "",
"City": "",
"CountryCode": "",
"PostCode": "",
"State": ""
},
"MIDs": [
{
"MID": ,
"Sum": ,
"PaymentInfo": [
{
"Caption": "",
"Value": ""
}
]
}
],
"Transaction": {
"TransactionID": "",
"TerminalID": "",
"DateTime": ""
}
}
~~~
</details>
:::

|Параметр|Обов'яз-ковість|Тип|Опис|Приклад|
|:----:|:----:|:----:|----|:----:|
| `Phone` | Так | Рядок | Телефон відправника у форматі "380ххххххххх". |`380679335544`|
| `Email` | Ні | Рядок | Email відправника. |`[e-mail]`|
| `Sum` | Так | Ціле | Сума операції у копійках. |1 грн.=>`100`|
| `Currency` | Так - при оплаті у валюті, відмінній від UAH. | Рядок | Код валюти *списання* – скорочене буквене позначення валюти, описане в стандарті [ISO 4217](https://uk.wikipedia.org/wiki/%D0%9A%D0%BB%D0%B0%D1%81%D0%B8%D1%84%D1%96%D0%BA%D0%B0%D1%86%D1%96%D1%8F_%D0%B2%D0%B0%D0%BB%D1%8E%D1%82_(ISO_4217)) (“GBP”, “USD” та ін.). |`UAH`|
| `Exchange` | Так - при оплаті у валюті, відмінній від UAH. | Рядок | Код валюти *зарахування* – скорочене буквене позначення валюти, описане в стандарті [ISO 4217](https://uk.wikipedia.org/wiki/%D0%9A%D0%BB%D0%B0%D1%81%D0%B8%D1%84%D1%96%D0%BA%D0%B0%D1%86%D1%96%D1%8F_%D0%B2%D0%B0%D0%BB%D1%8E%D1%82_(ISO_4217)) (“GBP”, “USD” та ін.). |`UAH`|
|`Sender`^1^|Так*|Структура | Структура, що передає дані банківського рахунку фактичного відправника.|Див. нижче.|
|`Recipient`^2^|Так*|Структура|Структура, що передає дані банківського рахунку одержувача (юридичної особи).|Див. нижче.|
|`SenderPerson`^3^|Так*|Структура|Структура, що передає персональні дані відправника.|Див. нижче.|
|`RecipientPerson`^4^|Так*|Структура|Структура, що передає персональні дані одержувача (фізичної особи).|Див. нижче.|
| `MIDs`^5^ | Ні | Масив | Параметр передається для здійснення платежу з гаманця мерчанта на користь надавача послуг за умови, що Партнер може використовувати баланси пов'язаних мерчантів. |Див. приклад нижче.|
| `Purpose` |Ні|Рядок|Призначення платежу.|`Переказ коштiв №1178341032 від KATERYNA KHOMCHENKO`|
|`Transaction`|Так|Структура|Структура, що передає дані про транзакцію. Див. розділ ["Структура "Transaction"](https://hackmd.io/g3cItPVFStez0ql3Xj-2TA#2-Data).|Див. нижче.|

**Параметри є умовно-обов’язковими залежно від форми переказу (визначаються на етапі інтеграції).*

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

| Параметр | Обов'яз-ковість | Тип | Опис | Приклад|
|:----:|:----:|:----:|----|:----:|
| `Name` |Ні |Рядок | Назва відправника. |`ТОВ "Альтера"`|
| `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`|
| `CountryResidence` | Ні | Рядок | Код країни проживання відправника, згідно довідника: ["ISO 3 digit"](https://docs.dnb.com/partner/en-US/iso_country_codes). |`470`|
| `Country` | Ні | Рядок | Код країни відправника. |`470`|
| `ActualCountry` | Ні | Рядок | Код країни відправника (фактичний). |`470`|
| `City` | Ні | Рядок | Назва міста відправника. |`City`|
| `Street` | Ні | Рядок | Назва вулиці відправника. |`Street`|
| `Building` | Ні | Рядок | Номер будинку відправника. |`1`|

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

| Параметр | Обов'яз-ковість | Тип | Опис | Приклад|
|:----:|:----:|:----:|----|:----:|
| `Name` |Ні |Рядок | Назва одержувача. |`ТОВ "Квадрат"`|
| `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`|

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

| Параметр | Обов'яз-ковість | Тип | Опис | Приклад|
|:----:|:----:|:----:|----|:----:|
| `FirstName` | Ні | Рядок | Ім'я відправника. |`Oleg`|
| `MiddleName` | Ні | Рядок | По батькові відправника. |`Mykhailovych`|
| `LastName` | Ні | Рядок | Прізвище відправника. |`Podilskyi`|
| `IPN` | Ні* </br> `IPN` або </br>`Birthday`+`Birthplace` | Рядок | Індивідуальний податковий номер (ІПН) відправника. |`111111111111`|
| `Birthday` | Ні* </br> `IPN` або </br>`Birthday`+`Birthplace` | Рядок | Дата народження відправника. |`2000-06-14`|
| `Birthplace` | Ні* </br> `IPN` або </br>`Birthday`+`Birthplace` | Рядок | Місце народження відправника. |`Vinnytsia, Ukraine`|
| `Phone` | Ні | Рядок | Телефон відправника у форматі: "380ххххххххх". |`380679335544`|
| `Email` | Ні | Рядок | Email відправника. |`[e-mail]`|
| `Address`** | Ні | Рядок | Білінгова адреса відправника. |`456 Main Street`|
| `City`** | Ні | Рядок | Назва міста відправника. |`San Diego`|
| `CountryCode`** | Ні | Рядок | Код країни відправника (ISO CODES), згідно табл. "[Country Codes](https://countrycode.org/)". |`US`|
| `PostCode`** | Ні | Рядок | Індекс відправника. |`92126`|
| `State`** | Ні | Рядок | Штат відправника. |`California (CA)`|

^4^ Параметри структури **"RecipientPerson"**:

| Параметр | Обов'яз-ковість | Тип | Опис | Приклад|
|:----:|:----:|:----:|----|:----:|
| `FirstName` | Ні | Рядок | Ім'я одержувача. |`Andriy`|
| `MiddleName` | Ні | Рядок | По батькові одержувача. |`Valeriyovych`|
| `LastName` | Ні | Рядок | Прізвище одержувача. |`Mazur`|
| `IPN` | Ні* </br> або`IPN`, або </br>`Birthday`+`Birthplace` | Рядок | Індивідуальний податковий номер (ІПН) одержувача. |`111111111111`|
| `Birthday` | Ні* </br> або`IPN`, або </br>`Birthday`+`Birthplace` | Рядок | Дата народження одержувача. |`2000-06-14`|
| `Birthplace` | Ні* </br> або`IPN`, або </br>`Birthday`+`Birthplace` | Рядок | Місце народження одержувача. |`Vinnytsia, Ukraine`|
| `Address`** | Ні | Рядок | Білінгова адреса одержувача. |`pl. Bankowy 3/5`|
| `City`** | Ні | Рядок | Назва міста одержувача. |`Warszawa`|
| `CountryCode`** | Ні | Рядок | Код країни одержувача (ISO CODES), згідно табл. "[Country Codes](https://countrycode.org/)". |`PL`|
| `PostCode`** | Ні | Рядок | Індекс одержувача. |`00-950`|
| `State`** | Ні | Рядок | Штат одержувача. |-|

:::warning
*Параметри `Birthday` та `Birthplace` передаються у разі відсутності `ІПН` відправника/одержувача.

**Параметри передаються лише при використанні картки відправника/одержувача, емітованої не банком України.
:::

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

| Параметр | Обов’яз-ковість | Тип | Опис | Приклад |
|:-:|:-:|:-:|-|:-:|
| `MID` |Так| Ціле | Ідентифікатор мерчанта в системі Оператора (Merchant ID), з гаманця якого здійснюється списання коштів. |`111`|
| `Sum` |Так| Ціле | Сума платежу у копійках.|1грн.=>`100` |
| `PaymentInfo`^6^ | Ні | Масив | Параметр передається для відображення деталей платежу на сторінці оплати. |Див. приклад нижче.|

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

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

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

~~~md
{
"Phone": "380637355533",
"Sum": 500200,
"Currency": "UAH",
"Exchange": "UAH",
"Purpose": "Переказ коштiв №1178341032",
"Sender": {
"MFO": "305299",
"Name": "ТОВ Альтера",
"EDRPOU": "",
"Account": "UA483052990000026008031203677",
"CountryResidence": "470",
"ActualCountry": "470",
"Country": "470",
"City": "City",
"Street": "Street",
"Building": "1"
},
"Recipient": {
"MFO": "305299",
"EDRPOU": "3505506226",
"Account": "UA483052990000026008031203677"
},
"RecipientPerson": {
"FirstName": "Andriy",
"LastName": "Mazur",
"IPN": "856431209583"
},
"MIDs": [
{
"MID": 111,
"Sum": 100,
"PaymentInfo": [
{
"Caption": "Призначення",
"Value": "Погашення за контрактом №3642989012-5 від 03.04.2021 Пупкіна Валерія Сергіївна"
}
]
},
{
"MID": 112,
"Sum": 200,
"PaymentInfo": [
{
"Caption": "Призначення",
"Value": "Погашення за контрактом №3642989012-5 від 03.04.2021 Пупкіна Валерія Сергіївна"
}
]
}
],
"Transaction": {
"DateTime": "20220712 22:39:02",
"TerminalID": "1",
"TransactionID": "1178341032"
}
}
~~~
</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": 555,
"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>
:::

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

:::info

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

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

~~~md
{
"Partner": {
"PartnerToken": "72a8ddb8-9145-4a41-af1a-8c48ecaa4be1",
"OperationType": 10303,
"Locale": "uk"
},
"Data": "{\"Phone\": \"380277777777\", \"Email\": \"[e-mail]\", \"Sum\": 5600, \"Currency\": \"UAH\", \"Exchange\": \"UAH\", \"Purpose\": \"\\u041f\\u0435\\u0440\\u0435\\u043a\\u0430\\u0437 \\u043a\\u043e\\u0448\\u0442i\\u0432 \\u21161178341032 \\u0432\\u0456\\u0434 KATERYNA KHOMCHENKO\", \"Sender\": {\"MFO\": \"305299\", \"Name\": \"Square LLC\", \"EDRPOU\": \"3505506226\", \"Account\": \"UA483052990000026008031203677\", \"CountryResidence\": \"470\", \"Country\": \"470\", \"City\": \"New York\", \"Street\": \"5420 Street\", \"Building\": \"21\"}, \"Recipient\": {\"Name\": \"Circle LLC\", \"MFO\": \"305311\", \"EDRPOU\": \"3505506337\", \"Account\": \"UA483052990000026008031203677\"}, \"SenderPerson\": {\"FirstName\": \"Test\", \"LastName\": \"Testovych\", \"MiddleName\": \"Testyansky\", \"IPN\": \"111111111111\", \"Birthday\": \"2000-06-14\", \"Birthplace\": \"Vinnytsia, Ukraine\", \"Address\": \"380288888888\", \"City\": \"Los Angeles\", \"CountryCode\": \"US\", \"PostCode\": \"92126\", \"State\": \"CA\"}, \"RecipientPerson\": {\"FirstName\": \"Anton\", \"LastName\": \"Pavlovych\", \"MiddleName\": \"Shpak\", \"IPN\": \"111111111222\", \"Birthday\": \"2000-06-14\", \"Birthplace\": \"Vinnytsia, Ukraine\", \"Address\": \"pl. Bankowy 3/5\", \"City\": \"Warszawa\", \"CountryCode\": \"PL\", \"PostCode\": \"00-950\", \"State\": \"\"}, \"MIDs\": [{\"MID\": 111, \"Sum\": 5600, \"PaymentInfo\": [{\"Caption\": \"\\u041f\\u0440\\u0438\\u0437\\u043d\\u0430\\u0447\\u0435\\u043d\\u043d\\u044f\", \"Value\": \"\\u041f\\u043e\\u0433\\u0430\\u0448\\u0435\\u043d\\u043d\\u044f \\u0437\\u0430 \\u043a\\u043e\\u043d\\u0442\\u0440\\u0430\\u043a\\u0442\\u043e\\u043c \\u21163642989012-5 \\u0432\\u0456\\u0434 03.04.2021 \\u041f\\u0443\\u043f\\u043a\\u0456\\u043d\\u0430 \\u0412\\u0430\\u043b\\u0435\\u0440\\u0456\\u044f \\u0421\\u0435\\u0440\\u0433\\u0456\\u0457\\u0432\\u043d\\u0430\"}]}], \"Transaction\": {\"TransactionID\": \"1ezQdLeqEQbl5unGqwo6MA\", \"TerminalID\": \"1\", \"DateTime\": \"20240221 15:37:01\"}}",
"KeyAES": "",
"Sign": ""
}
~~~
</details>

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

~~~md
{
"Code": 102,
"Message": "In progress",
"Data": {
"OperationID": 9620165,
"OperationStatus": 5
},
"KeyAES": "",
"Sign": ""
}
~~~
</details>
:::

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

[[10301/10311/103013] Гаманець-карта](https://hackmd.io/v5DKCslVSiGacRGLePCrOw)
[[10202] Гаманець-гаманець](https://hackmd.io/dDT3KzIgQjW8-v8rYo-pPg)
[[10304] Гаманець-UUID](https://hackmd.io/YFxvxD7nQJqD5lRJokBejw)
[[10400] Пакетна оплата гаманець-карта (по токену)](https://hackmd.io/e-zkU8N5T9CT3uNerArq8w)
[[10401] Пакетна оплата гаманець-карта (за номером карти)](https://hackmd.io/wvbMmdloQsiPSg-mp8e6Eg)

**Поповнення мобільного телефону**
[[10205] Гаманець-мобільний](https://hackmd.io/Ed0nf9UaRUuhBux_4NPeVg)
[[10305] Карта-мобільний](https://hackmd.io/XGJE11L3T_KwUtIR1Qlf_Q)
[[10405] Токен-мобільний](https://hackmd.io/gsTvGhrDTjqlNE_ZZa22vA)

**Отримання даних по проведеній операції**
[[20003] Отримання статусу операції](https://hackmd.io/fvd8btZLQXywluia6w5uxg)

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

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