Payment.Cancel

Отменяет платёж, созданный методом Payment.Create или Payment.Start.

Метод доступен, если Payment.Cancel присутствует в operations ответа Payment.Systems.Get. Отменяется полная сумма. Платёж не должен быть привязан к фискальному чеку продажи.

Повторный запрос с тем же идентификатором возвращает текущее состояние платежа. Если отмена или возврат недоступны, метод возвращает ошибку 704036.

Входные параметры

Название Тип данных Обязательность Описание
payment_id string Условно обязательный Локальный id платежа VCR из ответа Payment.Create или Payment.Start
external_id string Условно обязательный Идентификатор, переданный в Payment.Start

Нужно передать payment_id или external_id. Если переданы оба поля, используется payment_id.

Пример запроса

{
    "jsonrpc": "2.0",
    "method": "Payment.Cancel",
    "params": {
        "payment_id": "58847e73-b40b-4746-8a07-44582991bd6b"
    },
    "auth": "a2Fzc2E6a2FzMTIzNDU2",
    "id": 1
}

Выходные параметры

Метод возвращает объект платежа в формате Payment.Get.

Для асинхронной отмены вызывайте Payment.Get, передавая Payment.Cancel.result.id в поле payment_id:

Группа Статусы платежа
Операция выполняется 4, 9
Операция завершена 5, 8
Отмена не выполнена -1, 3, 7

Пример ответа

{
    "jsonrpc": "2.0",
    "result": {
        "id": "58847e73-b40b-4746-8a07-44582991bd6b",
        "payment_system_id": -3,
        "payment_id": "4f7afa7c-3d89-4fea-8025-a8b8f1e1468a",
        "status": 5,
        "amount": 1000000,
        "external_id": "ORDER-2026-000123"
    },
    "ok": true,
    "id": 1
}