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

# [20008] Отримання курсу валют

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

Запит [20008] застосовується для отримання поточного курсу валют.

## Запит

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

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

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

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

~~~
{
"CurrencyRate": [
{
"From": "",
"To": "",
"Type": ""
}
]
}
~~~
</details>
:::

| Параметр | Обов'яз-ковість | Тип | Опис | Приклад |
|:----:|:----:|:----:|----|:----:|
| `CurrencyRate` | Так | Масив | Масив, що передає дані курсу валют. |Див. приклад нижче.|

^1^ Параметри масиву **"CurrencyRate"**:

| Параметр | Обов'яз-ковість | Тип | Опис | Приклад|
|:----:|:----:|:----:|----|:----:|
| `From` | Так | Рядок | Код валюти, з якої конвертуються кошти, згідно стандарту [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)) ("UAH", "GBP", "USD" та ін.). |`USD`|
| `To` | Так | Рядок | Код валюти, на яку конвертуються кошти, згідно стандарту [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)) ("UAH", "GBP", "USD" та ін.). |`UAH`|
| `Type` | Так | Рядок | Постачальник курсу валют. |`MTB`|

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

~~~md
{
"CurrencyRate": [
{
"From": "USD",
"To": "UAH",
"Type": "MTB"
},
{
"From": "UAH",
"To": "USD",
"Type": "MTB"
}
]
}
~~~
</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).*

Успішна відповідь на запит [20008] містить масив `CurrencyRate`, в якому передаються дані поточного курсу валют:

| Параметр | Обов'яз-ковість | Тип | Опис |Приклад|
|:----:|:----:|:----:|----|:----:|
| `From` | Так | Рядок | Код валюти, з якої конвертуються кошти, згідно стандарту [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Non_ISO_4217_currencies) ("UAH", "GBP", "USD" та ін.). |`USD`|
| `Rate` | Так | Рядок | Поточний курс валютної пари. |`0.3703703703703704`|
| `To` | Так | Рядок | Код валюти, на яку конвертуються кошти, згідно стандарту [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Non_ISO_4217_currencies) ("UAH", "GBP", "USD" та ін.). |`UAH`|
| `Type` | Так | Рядок | Постачальник курсу валют. |`MTB`|

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

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

~~~md
{
"Code": 200,
"Message": "Done",
"Data": {
"CurrencyRate": [
{
"From": "USD",
"Rate": 0.3703703703703704,
"To": "UAH",
"Type": "MTB"
},
{
"From": "UAH",
"Rate": 2.7,
"To": "USD",
"Type": "MTB"
}
],
"OperationDate": "2022-10-13T16:01:10.910404+03:00",
"OperationID": 2313790,
"OperationStatus": 10
},
"KeyAES": "",
"Sign": ""
}
~~~
</details>
:::

:::success
<details>
<summary>Операція проведена успішно - значення курсу відсутнє</summary>
<br>

~~~md
{
"Code": 200,
"Message": "Done",
"Data": {
"CurrencyRate": [
{
"From": "USD",
"Rate": null,
"To": "UAH",
"Type": "MTB"
},
{
"From": "UAH",
"Rate": null,
"To": "USD",
"Type": "MTB"
}
],
"OperationDate": "2022-10-13T16:02:54.258959+03:00",
"OperationID": 2313791,
"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": 20008
},
"Data": "{\"CurrencyRate\":[{\"From\":\"USD\",\"To\":\"UAH\",\"Type\":\"MTB\"}]}",
"KeyAES": "",
"Sign": ""
}
~~~
</details>

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

~~~md
{
"Code": 200,
"Message": "Done",
"Data": {
"CurrencyRate": [
{
"From": "USD",
"Rate": null,
"To": "UAH",
"Type": "MTB"
}
],
"OperationDate": "2023-04-05T15:39:05.447907+03:00",
"OperationID": 9505517,
"OperationStatus": 10
},
"KeyAES": "",
"Sign": ""
}
~~~
</details>
:::

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

[[20001] Отримання балансу гаманця](https://hackmd.io/c-2sDICDRGeplJ-QL8bETw)
[[20002] Отримання виписки по гаманцю](https://hackmd.io/L9EeXtQYRDCQD_IhAPKhMw)
[[20003] Отримання статусу операції](https://hackmd.io/fvd8btZLQXywluia6w5uxg)
[[20004] Отримання квитанції по операції](https://hackmd.io/mOA9rZ_xSxWrNZxKzvZ5HQ)
[[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>