# Запрос баланса

Метод возвращает **балансы проектов** партнёра: средства, доступные для выплат, ожидаемое зачисление и сумму в холде. Используйте запрос для контроля лимитов перед [выплатами](/pages/payout-types).

Формат HTTP-запросов — в разделе [Формат запроса к API](/pages/init-request).

## Принцип работы

1. **Запрос** — ваш сервер вызывает `get_balance` с `partner_id` и подписью `sign`.
2. **Проверка** — API проверяет подпись и права партнёра.
3. **Ответ** — JSON со списком `project_balance` по каждому проекту.


## Техническая информация

|  |  |
|  --- | --- |
| **Эндпоинт** | `https://api.1payment.com/get_balance` |
| **Методы** | `GET`, `POST` |
| **Формат ответа** | JSON |


## Параметры запроса

### Обязательные

| Параметр | Тип | Описание |
|  --- | --- | --- |
| `partner_id` | Integer | Ваш уникальный ID в системе 1Payment. |
| `sign` | String | Контрольная подпись запроса (см. раздел «Подпись»). |


## Формирование подписи (`sign`)

Подпись: MD5, lowercase (hex). Общие правила — [Формат запроса к API](/pages/init-request#%D0%BF%D0%BE%D0%B4%D0%BF%D0%B8%D1%81%D1%8C-%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D0%B0-sign).

**Формула:**


```text
MD5(get_balance + <параметры_без_sign_в_алфавитном_порядке_через_&> + <API_KEY>)
```

**Пример строки до хеширования:**


```text
get_balancepartner_id=1234secret_key
```

### Проверка подписи в документации

## Примеры запроса

Node.js

```javascript
const crypto = require('crypto');
const axios = require('axios');

async function getBalance(apiKey, partnerId) {
  const params = { partner_id: partnerId };

  // 1. Сортировка параметров по алфавиту
  const sortedKeys = Object.keys(params).sort();
  const queryString = sortedKeys.map((key) => `${key}=${params[key]}`).join('&');

  // 2. Подпись с префиксом get_balance
  const baseString = `get_balance${queryString}${apiKey}`;
  params.sign = crypto.createHash('md5').update(baseString).digest('hex');

  // 3. GET-запрос
  const response = await axios.get('https://api.1payment.com/get_balance', { params });
  return response.data;
}

const apiKey = process.env.ONEPAYMENT_API_KEY;
getBalance(apiKey, 1234).then(console.log);
```

Python

```python
import hashlib
import os
import requests

def get_balance(api_key: str, partner_id: int) -> dict:
    params = {"partner_id": partner_id}

    # 1. Сортировка параметров
    sorted_keys = sorted(params.keys())
    query_string = "&".join(f"{k}={params[k]}" for k in sorted_keys)

    # 2. Подпись get_balance
    base_string = f"get_balance{query_string}{api_key}"
    params["sign"] = hashlib.md5(base_string.encode("utf-8")).hexdigest()

    # 3. GET-запрос
    response = requests.get("https://api.1payment.com/get_balance", params=params)
    response.raise_for_status()
    return response.json()

api_key = os.environ["ONEPAYMENT_API_KEY"]
print(get_balance(api_key, 1234))
```

PHP

```php
<?php

function getBalance(string $apiKey, int $partnerId): string
{
    $params = ['partner_id' => $partnerId];

    // 1. Сортировка параметров по алфавиту
    ksort($params, SORT_LOCALE_STRING);
    $tail = '';
    foreach ($params as $k => $v) {
        if ($k === 'sign') {
            continue;
        }
        $tail .= "{$k}={$v}&";
    }
    $tail = substr($tail, 0, -1);

    // 2. Формирование подписи (префикс get_balance)
    $params['sign'] = md5('get_balance' . $tail . $apiKey);

    // 3. Запрос к API
    $url = 'https://api.1payment.com/get_balance?' . http_build_query($params);
    $ch = curl_init($url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    $response = curl_exec($ch);
    curl_close($ch);

    return $response;
}

$apiKey = getenv('ONEPAYMENT_API_KEY');
echo getBalance($apiKey, 1234);
```

cURL

```bash
# Подпись: md5("get_balance" + partner_id=1234 + API_KEY)

curl -sS "https://api.1payment.com/get_balance?partner_id=1234&sign=PASTE_MD5_HEX"
```

## Ответ API

Успешный ответ (`200`):


```json
{
  "project_balance": [
    {
      "project_id": 123,
      "currency": "RUB",
      "payout_balance": 100,
      "hold": 0
    },
    {
      "project_id": 456,
      "currency": "USD",
      "payout_balance": 200,
      "expected_balance": 400,
      "hold": 0
    }
  ]
}
```

| Поле | Описание |
|  --- | --- |
| `project_balance` | Массив балансов по проектам партнёра. |
| `project_id` | ID проекта. |
| `currency` | Валюта (ISO 4217). |
| `payout_balance` | Средства, доступные для выплат на текущий момент. |
| `expected_balance` | Ожидаемый баланс после зачисления всех средств (если передано). |
| `hold` | Сумма в холде. |


Ошибка запроса (`400`):


```json
{
  "error_code": 2
}
```

Расшифровка `error_code` — в [Коды ошибок (API)](/pages/error-codes-api). При нехватке средств для выплаты в других методах возможен код `9`.

## Связанные разделы

- [Типы выплат](/pages/payout-types)
- [Статус выплаты](/pages/payouts/status)