Skip to content

Метод cancelOperation ​

Описание ​

Метод предназначен для отмены полного и/или частичного погашения сертификата. Для выполнения отмены операции необходимо сохранять идентификатор изначальной операции погашения.

Параметры запроса (data) ​

ПараметрТипОписание
codestringОбязательное. Код сертификата.
transaction_idintОбязательное. Идентификатор операции погашения. Возвращается методом redeemCertificate в параметре transaction_ids.
emailstringОбязательное. Email выполнившего операцию сотрудника (в случае автоматической отмены можно передать заглушку noreply@{yourdomain}.{tld})
commentstringКомментарий для отмены операции

Параметры ответа (data) ​

ПараметрТипОписание
canceledboolБыла ли операция погашения успешно отменена

Пример ​

bash
# Получаем значение для подстановки SIG
# SECRET в данном случае - это хранящийся у клиента ключ для подписи запросов к API
$ echo -n 'cancelOperation{"code":"00342-999-999-999","transaction_id":999,"email":"noreply@giftery.ru"}SECRET' | sha256sum - | awk '{print $1}'

# Используем известный клиенту ID и сгенерированный SIG для выполнения запроса
$ curl 'https://ssl-api.giftery.ru/?cmd=cancelOperation&id=ID&in=json&out=json&data=%7B%22code%22%3A%2200342-999-999-999%22%2C%22transaction_id%22%3A999%2C%22email%22%3A%22noreply%40giftery.ru%22%7D&sig=SIG'

Результат успешного запроса ​

JSON
{
  "status": "ok",
  "data": {
    "canceled": true
  }
}

Результат в случае ошибки ​

JSON
{
    "status": "error",
    "error": {
        "code": 1402,
        "text": "Сертификат не найден"
    }
}
Код ошибкиОписание
1402Не удалось найти сертификат по предоставленному коду. Нужно проверить правильность передачи кода. Проверка пин-кода происходит только если сертификат был найден.
1403Сертификат был заблокирован. Причину блокировки можно уточнить и персонального менеджера.
3601Превышено время отмены операции. Отменяемая операция погашения была более 5 дней назад.