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

# [20001] Отримання балансу гаманця

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

Запит [20001] застосовується для отримання поточного балансу гаманця.

## Запит

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

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

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

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

~~~
{
"ID": "",
"Decrypted":
}
~~~
</details>
:::

| Параметр | Обов'яз-ковість | Тип | Опис | Приклад |
|:----:|:----:|:----:|----|:----:|
|`ID`|Так - за наявності декількох гаманців.|Рядок|Унікальний ідентифікатор гаманця у системі Оператора, для якого формується баланс.|`UAH897589401`|
|`Decrypted`|Ні|Булевий|Ознака незашифрованості відповіді: </br> `true` - відповідь у незашифрованому вигляді; </br> `false` (значення за замовчуванням) - відповідь у зашифрованому вигляді.|`true`|

## Відповідь

*Загальна інформація по формуванню структури відповіді наведена у розділі [“Загальна інформація по підключенню (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).*

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

| Параметр | Обов'яз-ковість | Тип | Опис |Приклад|
|:----:|:----:|:----:|----|:----:|
| `Sum` |Так | Ціле | Баланс гаманця у копійках. |1грн.=>`100`|
|`ID`|Так|Рядок|Унікальний ідентифікатор гаманця у системі Оператора. |`UAH703758543`|
|`DateTime`|Ні|Рядок|Дата та час запиту балансу у форматі: YYYY-MM-DD HH24:MM:SS.|`20180510 13:23:19`|

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

:::success
<details>
<summary>Формування балансу гаманця у незашифрованому вигляді</summary>
<br>

~~~md
{
"Code": 200,
"Message": "done",
"Data": {
"OperationDate": "2022-07-01T06:30:00.985179+03:00",
"OperationID": 9397318,
"OperationStatus": 10,
"decodedData": "{\"ID\":\"UAH897589401\",\"Sum\":50000,\"DateTime\":\"20180510 13:23:19\"}"
},
"KeyAES": "",
"Sign": ""
}
~~~
</details>
:::

:::success
<details>
<summary>Формування балансу гаманця у зашифрованому вигляді</summary>
<br>

~~~md
{
"Code": 200,
"Message": "done",
"Data": {
"OperationDate": "2022-07-01T06:30:00.985179+03:00",
"OperationID": 9397318,
"OperationStatus": 10,
"encodedData": "qJfPZG1jvzr1vA/eLcUc2FodP3tF2YiTN5YLck+wYTKcyXwA+RLvqkXzzOVoRop6u8hJbLYcd/iFx7cf6x/AB1oQ3EfWs99R4wT2xjyaVKE="
},
"KeyAES": "GVUYl0x/c1VzB8RwVHO3ktRvwb5Z4haVfdgqBKSrRTRQiqo/RXygI7W2YAJ/kjEDBbKRa8pig8q9qme2TiF6zcpXMIA9prqydurp5mZSaPrvCy1s6gmz1xddF2Wkpe3nJIotWOjvItbO1BcCUdBOCAeCp/tWLPnGdHOUnrapI6SZi0cKOLcBzVARMD91KTqPhNg3DE809bcXRdGSukZQfNNvTSG2ITd/+L5J623BBexLgtwwLj0AXivcmEwvKJl65IhzSos3zCJ2CFrFqvg+j3mZQmR7B8L6ysopVlmh5QrcLv7XvfaoZwW+jhxWFuc63KW9S8VfuhjbQC0VcnXssQ==",
"Sign": "CkLM5Y6LVsj9q2NIq6uiHwaOYwE2o7RWBFh2VHc7QHdeUM7vC5tJptdrXNvae/5dJ2pjejrRNot9mQVh8Fhp6h+tYxqK0DkXd7L/SPfF5WUFEsliHrHEipGMLOI1vHV9wvkhNWzjpKhK44BOVfdxxt8Uocz4FPRZlIxyjg3TsBvtb+zCOKK7BshdjBF8YKh5h22x0nOJ+0e/OwmC5xN1s3+NH7UNULzisaX5zUQ4V6sYIK0snNJexBDrq43llZ3Y0hfyz2ggwS34bEC+i9t4DPw/Sg6s30QafsgAVw4EvQGc3505Xd003J0QVQfStPxs+5ela7GWDJ4/tTCCEFRnew=="
}
~~~
</details>
:::

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

:::info

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

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

~~~md
{
"Partner": {
"PartnerToken": "72a8ddb8-9145-4a41-af1a-8c48ecaa4be1",
"OperationType": 20001
},
"Data": "{\"Decrypted\": true, \"ID\": \"UAH897589401\"}",
"KeyAES": "",
"Sign": ""
}
~~~
</details>

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

~~~md

~~~
</details>
:::

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

[[20002] Отримання виписки по гаманцю](https://hackmd.io/L9EeXtQYRDCQD_IhAPKhMw)
[[20003] Отримання статусу операції](https://hackmd.io/fvd8btZLQXywluia6w5uxg)
[[20004] Отримання квитанції по операції](https://hackmd.io/mOA9rZ_xSxWrNZxKzvZ5HQ)
[[20008] Отримання курсу валют](https://hackmd.io/inushlCxQa2f0MRgvVD7eg)
[[20009] Отримання ліміту по операції [10101]](https://hackmd.io/a_-XSuzvRvG9t9cU2yoUvg)
[[20110] Отримання даних карти](https://hackmd.io/zFCegCSASKKjGCmoJkTYmw)

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

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