> For the complete documentation index, see [llms.txt](https://help.unitpay.ru/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.unitpay.ru/payouts/balans-dostupnyi-k-vyplate-api.md).

# Баланс, доступный к выплате (API)

С помощью этого запроса вы сможете узнать доступный к выплате баланс по конкретному методу выплаты. 

```bash
GET https://unitpay.ru/api

method            = massPaymentAvailableAmount
login             = unitpay-test@example.ru
secretKey         = sk_live_2YQt9m
sum               = 5
purse             = 79123456789
paymentType       = sbp
recipientCurrency = RUB
```

**Обязательные параметры:**

<table data-header-hidden><thead><tr><th width="195.111083984375">name</th><th width="138.22212727864581">type</th><th>description</th></tr></thead><tbody><tr><td><strong>login</strong></td><td>строка</td><td>E-mail аккаунта в системе UnitPay</td></tr><tr><td><strong>secretKey</strong></td><td>строка</td><td>Секретный ключ аккаунта, доступен в <a href="https://unitpay.ru/partner/profile/edit">настройках профиля</a></td></tr><tr><td><strong>sum</strong></td><td>число</td><td>Сумма выплаты (например, 10)</td></tr><tr><td><strong>purse</strong></td><td>строка</td><td>Реквизит для получения выплаты (например,  номер телефона, номер банковской карты)</td></tr><tr><td><strong>paymentType</strong></td><td>строка</td><td>Наименование метода выплаты</td></tr></tbody></table>

**Необязательные параметры:**&#x20;

<table><thead><tr><th width="197.88885498046875">name</th><th width="138.333251953125">type</th><th>description</th></tr></thead><tbody><tr><td><strong>recipientCurrency</strong></td><td>строка</td><td>Валюта выплаты (RUB - для всех выплат через банковские карты, СБП)</td></tr></tbody></table>

**Пример успешного ответа:**&#x20;

```json
{
    "result": {
        "availableAmount": 1057.36,
        "currency": "RUB"
    }
}
```

<table><thead><tr><th width="195.66668701171875">name</th><th width="134.8887939453125">type</th><th>description</th></tr></thead><tbody><tr><td><strong>availableAmount</strong></td><td>число</td><td>Баланс, доступный к выводу</td></tr><tr><td><strong>currency</strong></td><td>строка</td><td>Валюта запрашиваемого баланса</td></tr></tbody></table>

**Пример ошибочного ответа:**

```json
{
    "error": {
        "message": "Неверные параметры авторизации",
        "code": -32000
    }
}
```

<table data-header-hidden><thead><tr><th width="219.55548095703125">name</th><th>description</th></tr></thead><tbody><tr><td><strong>-32000</strong></td><td>Неверные параметры авторизации (логин, секретный ключ)</td></tr><tr><td><strong>-32602</strong></td><td>Неверные параметры запроса (некорректно составлен запрос)</td></tr><tr><td><strong>-32603</strong></td><td>Внутренняя техническая ошибка</td></tr></tbody></table>