Состояние баланса пользователя

Запрос позволяет получить информацию о балансе пользователя. Тело ответа содержит код валюты и количество денег на счете.

Формат запроса

Чтобы получить информацию о лицевом счете, используйте HTTP-запрос с методом GET:

GET /projects/<project_id>/services/<service_id>/personal_account
Host: api-developer.tech.yandex.net
X-Auth-Key: <ваш API-ключ>
Ресурс

<project_id>

Идентификатор проекта.

<service_id>

Идентификатор сервиса.

Заголовки запроса

Host

Адрес узла, предоставляющего API.

X-Auth-Key

Ключ авторизации.

Формат ответа

В случае успешного выполнения запроса API возвращает ответ с кодом 200. Тело ответа содержит объект в формате JSON:

{
    "personal_account": {
        "currency": "RUB",
        "sum": "0"
    }
}

Свойства ответа

Ключ

Значение

personal_account

Объект с информацией о балансе.

Свойства массива personal_account

currency

Код валюты, в которой хранятся деньги на счете.

sum

Количество денег на счете.

Если запрос не был успешно обработан, ответное сообщение содержит информацию о возникших ошибках:

HTTP-код ошибки

Описание ошибки

400 Bad Request

Один из параметров запроса имеет недопустимое значение или формат данных.

403 Forbidden

У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.

404 Not Found

Запрашиваемый ресурс не найден.

500 Internal Server Error

Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.

503 Service Unavailable

Сервис API временно недоступен.

Идентификатор проекта.

Адрес узла, предоставляющего API.

Ключ авторизации.

Идентификатор сервиса.