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

# [10305] Карта-мобільний

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

Запит [10305] застосовується для поповнення мобільного телефону карткою.

## Запит

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

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

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

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

~~~
{
"SenderCard": {
"PAN": "",
"ExpMon": "",
"ExpYear": "",
"CVV": ""
},
"Phone": "",
"Email": "",
"Action": "Prepare” / “Pay",
"Sum": ,
"Recipient": "",
"Transaction": {
"TransactionID": "",
"TerminalID": "",
"DateTime": ""
}
}
~~~
</details>
:::

|Параметр|Обов'яз-ковість|Тип|Опис|Приклад|
|:----:|:----:|:----:|----|:----:|
|`SenderCard`^1^|Так|Структура|Структура, що передає дані банківської картки відправника.|Див. нижче.|
| `Phone` | Так | Рядок | Телефон відправника </br> (формат-"380ххххххххх"). |`380679335544`|
| `Email` | Ні | Рядок | Email відправника. |`[e-mail]`|
|`Action`|Ні|Рядок|Тип запиту. Можливі значення: `Prepare` – розрахунок комісії, </br> `Pay` - проведення оплати (значення за замовчуванням).|`Prepare` або `Pay`|
| `Sum` | Так | Ціле | Сума операції у копійках. |1 грн.=>`100`|
|`Recipient`|Так|Рядок|Номер мобільного телефону, що поповнюється (формат-"380ххххххххх"). |`380675670090`|
|`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`|

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

~~~md
{
"Sum": 25000,
"Phone": "380934728867",
"Action": "Pay",
"Recipient": "380733180234",
"SenderCard": {
"CVV": "***",
"PAN": "426046******2950",
"ExpMon": "08",
"ExpYear": "24"
},
"Transaction": {
"DateTime": "2022-07-13 09:53:39",
"TerminalID": "88b326d1-dc1f-48bf-b36a-dc9768e96117",
"TransactionID": "cc50127f-1405-4160-afa6-36437c07c8dd"
}
}
~~~
</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).*

### Параметр "Action":"Prepare"

При надісланому значенні запиту `"Action":"Prepare"` - у структурі “Data” передаються дані розрахунку комісії:

| Параметр | Обов'яз-ковість | Тип | Опис | Приклад|
|:----:|:----:|:----:|----|:----:|
|`Sum`|Так|Ціле|Сума переказу в копійках. |`500`|
|`Fee`|Так|Ціле|Сума комісії у копійках.|`50`|
|`TotalSum`|Так|Ціле|Загальна сума переказу в копійках з урахуванням комісії.|`550`|

:::success
<details>
<summary>Приклад відповіді при значенні запиту "Action":"Prepare"</summary>
<br>

~~~md
{
"Code": 102,
"Message": "done",
"Data": {
"Sum": 500,
"Fee": 50,
"TotalSum": 550,
"OperationStatus": 7
},
"KeyAES": "",
"Sign": ""
}
~~~
</details>
:::

### Параметр "Action":"Pay"

:::info
Для проведення платежу необхідно повторити запит [10305] з тими ж даними, але в параметрі `Action` вказати значення `Pay`.
:::

У структурі успішної відповіді передається параметр `RRN` та структура `Receipt`:

| Параметр | Обов'яз-ковість | Тип | Опис |Приклад|
|:----:|:----:|:----:|----|:----:|
| `RRN` | Так | Рядок | RRN карткової транзакції (*Reference Retrieval Number* - унікальний ідентифікатор банківської транзакції). |`015014474493`|
|`Receipt`^2^|Так|Структура|Структура, що передає дані поповнення.|Див. нижче.|

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

| Параметр | Обов'яз-ковість | Тип | Опис | Приклад|
|:----:|:----:|:----:|----|:----:|
| `payment_purpose` |Так| Рядок | Призначення платежу. |`Оплата за послуги мобільного звязку`|
| `recipient_account` |Так| Рядок | IBAN одержувача (міжнародний номер банківського рахунку). | `UA1730529900000-26207893720887`|
| `recipient_bank` |Так| Рядок | Банк одержувача. | `ПАТ "АЛЬФА-БАНК" У М.КИЄВІ` |
| `recipient_edrpou` |Так| Рядок | ЄДРПОУ одержувача. | `21673832` |
| `recipient_mfo` |Так| Рядок | МФО банку одержувача. | `300346` |
| `recipient_name` |Так| Рядок | ПІБ (назва) одержувача. | `ПрАТ "Київстар"` |

:::warning
У разі повторного запиту, або отримання статусу операції, дані `Receipt` не надсилаються.
:::

#### Приклади відповідей при значенні запиту "Action":"Pay"

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

~~~md
{
"Code": 200,
"Message": "Ok",
"Data": {
"OperationDate": "2020-12-07T17:03:06.661937+02:00",
"OperationID": 29561653,
"OperationStatus": 10,
"RRN": "015014474493",
"Receipt": {
"payment_purpose": "Оплата за послуги мобільного звязку",
"recipient_account": "UA403003460000026008010065101",
"recipient_bank": "ПАТ «АЛЬФА-БАНК» У М.КИЄВІ",
"recipient_edrpou": "21673832",
"recipient_mfo": "300346",
"recipient_name": "ПрАТ «Київстар»"
}
},
"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": 10305
},
"Data": "{\"SenderCard\":{\"PAN\":\"8888888888888888\",\"ExpMon\":\"12\",\"ExpYear\":\"24\",\"CVV\":\"356\"},\"Phone\":\"380277777777\",\"Email\":\"[e-mail]\",\"Action\":\"Pay\",\"Sum\":29000,\"Recipient\":\"380288888888\",\"Transaction\":{\"TransactionID\":\"0c5328f5-bda9-4376-b6a0-ca544fcb51fc\",\"TerminalID\":\"1\",\"DateTime\":\"2023040414:04:24\"}}",
"KeyAES": "",
"Sign": ""
}
~~~
</details>

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

~~~md
{
"Code": 200,
"Message": "Done",
"Data": {
"OperationDate": "2023-04-04T15:09:39.089487+03:00",
"OperationID": 9504405,
"OperationStatus": 10,
"result": "OK"
},
"KeyAES": "",
"Sign": ""
}
~~~
</details>
:::

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

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

**Поповнення мобільного телефону**
[[10205] Гаманець-мобільний](https://hackmd.io/Ed0nf9UaRUuhBux_4NPeVg)
[[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>