Метод: get_balance
Метод предназначен для уточнения текущего баланса партнера.
URL
POST https://api-pvk.prostodar.ru/partner/get_balance/
Описание
Метод возвращает текущий баланс счета партнера. Для выполнения запроса требуется передать авторизационные данные и использовать шифрование данных с помощью открытого ключа.
Структура запроса
Пример запроса
Формат запроса:
POST https://api-pvk.prostodar.ru/partner/get_balance/
?partnerName=name
&partnerPassword=password
&useAuthByCert=Y
Параметры запроса
| Параметр |
Тип |
Описание |
Обязательный |
Шифрование |
Цвет |
partnerName |
string |
Уникальное имя партнера |
Да |
Нет |
|
partnerPassword |
string |
Уникальный API пароль партнера |
Да |
Да |
|
useAuthByCert |
string |
Указывает на шифрование данных |
Да |
Нет |
|
Описание вставляемых параметров
- partnerName: Уникальное имя партнера (например,
"mts").
- partnerPassword: Уникальный API пароль партнера.
- useAuthByCert: Указывает на использование шифрования данных. Возможные значения:
"Y" (включено) или "N" (выключено).
Структура ответа
Пример успешного ответа
{
"status": "OK",
"balance": 10000
}
Параметры успешного ответа
| Параметр |
Тип |
Описание |
status |
string |
Статус прохождения запроса |
balance |
float |
Баланс счета партнера |
Пример ответа с ошибкой
{
"status": "PARTNER_LOGIN_IS_NOT_CORRECT",
"message": "Partner name or password is not correct"
}
Параметры ответа с ошибкой
| Параметр |
Тип |
Описание |
status |
string |
Статус ошибки |
message |
string |
Текстовое описание ошибки |
Возможные ошибки
| Статус |
Описание |
PARTNER_LOGIN_IS_NOT_CORRECT |
Партнер с таким логином и паролем не найден |
NOT_VALID_IP_PARTNER |
IP партнера некорректен |
ACCOUNT_IS_BLOCKED |
Аккаунт заблокирован |