Возможно отменить подписку, которая находится в статусе (status) активна (1) или просрочена (2).
URL: https://paymentnut.ru/api/subscription_cancel/v1
Метод отправки: POST, параметры передаются в теле запроса в формате ключ=значение
Аутентификация: используется HTTP Basic Auth – отправка логина и пароля в заголовке HTTP–запроса. В качестве логина используется Идентификатор проекта, в качестве пароля – API ключ. Оба этих значения доступны в настройках проекта Личного Кабинета его владельцу.
Поддерживаемые параметры:
Наименование параметра |
Описание |
Допустимые символы |
Минимальное, максимальное кол–во знаков |
Допустимые значения |
Обязателен |
Пример |
subscription_id |
Идентификатор подписки |
[a-zA-Z0-9] |
32,32 |
– |
Да |
139ABC3D0B0D7B324158679D42BAE0A8 |
Пример запроса (PHP и CURL):
$project_id='0D2239F1BBDAA3E4F98CFD0CDF2F9D73';
$api_key='1EA457132ABC39FBBA99A0EEFE0BF13D';
$url='https://paymentnut.ru/api/subscription_cancel/v1';
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_USERPWD, $project_id . ":" . $api_key);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,"subscription_id=139ABC3D0B0D7B324158679D42BAE0A8");
$response=curl_exec($ch);
$response=json_decode($response, true);
print_r($response);
Ответ
В случае успешного принятия запроса, возвращается JSON с response_code=1, подписка отменяется, плательщику отправляется электронное письмо об отмене подписки.
В случае неуспешного выполнения запроса возвращается JSON с response_code=0, response=x. Возможные значения response (ошибок) приводятся ниже.
Возвращаемые ошибки (response_code=0, response=x)
Response |
Значение |
1 |
Некорректное значение Идентификатора проекта в логине HTTP Basic Auth |
2 |
Некорректное значение API ключа в пароле HTTP Basic Auth |
3 |
Некорректное значение поля subscription_id |
4 |
Идентификатор проекта или API ключ указан неверно, проекту не согласован данный метод API, или проект не может работать по API |
5 |
Подписка не найдена |
6 |
Подписка не может быть отменена (например, уже отменена) |
7 |
Команда на отмену подписки уже выполняется (команда выполняется в течении нескольких минут) |