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

# [40003] Отримання балансу платіжного інструменту

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

Отримання балансу платіжного інструменту доступне для наступних платіжних інструментів:
* гаманець XPAY;
* картка банку Партнера.

Операція запиту балансу може вимагати додаткової OTP-ідентифікації.
Схему взаємодії див. у розділі "[Загальна схема взаємодії](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": "",
"UUID": "",
"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=`|
|`UUID`|Так|Рядок|UUID (унікальний ідентифікатор) платіжного інструменту, за яким потрібно отримати баланс. |`ead5ea7a-f19f-44ec-8742-3621b4bfdc18`|
|`Transaction`|Так|Структура|Структура, що передає дані про транзакцію. Див. розділ ["Структура "Transaction"](https://hackmd.io/g3cItPVFStez0ql3Xj-2TA#2-Data).|Див. нижче.|

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

~~~md
{
"Partner": {
"PartnerToken": "3b4e5666-b585-491a-af31-516e47b25041",
"OperationType": 40003
},
"Data": "{\"Phone\": \"380679335544\", \"UserID\": \"Uwuh0B5GQVuokYSL\", \"DeviceID\": \"0Ht9z0yh5aDNr5js1zGFz5QTmIE=\", \"UUID\": \"ead5ea7a-f19f-44ec-8742-3621b4bfdc18=\", \"Transaction\": {\"DateTime\": \"2022-04-21 02:46:33\", \"TerminalID\": \"1\", \"TransactionID\": \"JXECMxR4IUCqtsqr5KBkABrKC0M=\"}}",
"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).*

Успішна відповідь на запит [40003] містить структуру `DecodedData`/`EncodedData`, у якій передаються незашифровані або зашифровані дані балансу платіжного інструменту:

| Параметр | Обов'яз-ковість | Тип | Опис |Приклад|
|:----:|:----:|:----:|----|:----:|
|`uuid`|Так|Рядок|UUID (унікальний ідентифікатор) платіжного інструменту, за яким отримується баланс. |`ead5ea7a-f19f-44ec-8742-3621b4bfdc18`|
| `Sum` |Так | Ціле | Баланс платіжного інструменту у копійках. |1грн.=>`100`|
|`DateTime`|Ні|Рядок|Дата та час запиту балансу у форматі: YYYYMMDD HH24:MM:SS.|`20180510 13:23:19`|

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

:::success
<details>
<summary>Баланс по рахунку у незашифрованому вигляді</summary>
<br>

~~~md
{
"Code": 200,
"Message": "done",
"Data": {
"DecodedData": "{\"uuid\":\"1b982500-59bb-4ec8-8c03-a4cbabea1355\",\"Sum\":50000,\"DateTime\":\"20180510 13:23:19\"}"
},
"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>