Запрос баланса выплат

Эта статья о том, что такое баланс выплат, на что он влияет и как его узнать по API.

Зачем узнавать баланс выплат

Баланс выплат — это та сумма денег, которую вы выделили для проведения выплат через ЮKassa. ЮKassa проводит выплаты только в том случае, если на балансе выплат есть необходимая сумма. Если денег не хватает, ЮKassa отменит выплату и укажет причину insufficient_funds.

Пример выплаты в статусе canceled с причиной отмены insufficient_funds

JSON
{
    "id": "po-285ec15d-0003-5000-a000-08d1bec7dade",
    "amount": {
        "value": "2.00",
        "currency": "RUB"
    },
    "status": "canceled",
    "payout_destination": {
        "type": "yoo_money",
        "account_number": "410011806060766"
    },
    "description": "Payout for order No. 37",
    "created_at": "21.06.2021T14:28:45.132Z",
    "cancellation_details": {
        "party": "yoo_money",
        "reason": "insufficient_funds"
    },
    "metadata": {
        "order_id": "37"
    },
    "test": "false"
}

Баланс отображается в личном кабинете ЮKassa и в личном кабинете ЮBusiness, но при необходимости вы можете его узнать по API. Например, чтобы проверить перед выплатой, что на балансе хватает денег.

Как узнать баланс по API

Чтобы узнать баланс выплат по API, запросите информацию о настройках вашего шлюза , передав в запросе данные для аутентификации (идентификатор шлюза и секретный ключ).

Пример запроса на получение информации о настройках шлюза

cURL
PHP
Python
curl https://api.yookassa.ru/v3/me \
  -X GET \
  -u <Gateway ID>:<Secret Key> \

В ответ вернется объект настроек шлюза, данные которого использовались для аутентификации. Баланс выплат будет указан в параметре payout_balance.

Пример объекта с информацией о настройках шлюза

JSON
{
    "account_id": "100500",
    "test": false,
    "payout_methods": [
        "bank_card",
        "yoo_money"
    ],
    "name": "<Name of the gateway in the YooMoney Merchant Profile>",
    "payout_balance": {
        "value": "1000.47",
        "currency": "RUB"
    },
    "status": "enabled"
}

Если вы запрашиваете настройки тестового шлюза, баланс выплат будет отрицательным.

Как пополнить баланс

Баланс выплат нужно пополнять с вашего расчетного счета в ЮBusiness. Adding money to the balance