Метод cancelPayment

Attention. Это старая версия API. Переходите на API Яндекс.Кассы.

Описание

Отмена отложенного платежа.

Адрес для вызова операции cancelPayment

https://server:port/webservice/mws/api/cancelPayment

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

Параметр

Тип

Описание

requestDT

dateTime

Время формирования запроса на выполнение операции по часам магазина.

orderId

long

Номер транзакции отложенного перевода, выдается Яндекс.Кассой в параметре invoiceId .

ym_merchant_receiptstring

Данные для формирования чека в формате JSON (так же, как в платежной форме).

Параметр передается и является обязательным, если:

  • вы настроили взаимодействие со своей онлайн-кассой через Яндекс.Кассу и передаете в платежной форме данные для формирования чека;
  • у отменяемой операции на этапе авторизации не был передан чек.

Параметр

Тип

Описание

requestDT

dateTime

Время формирования запроса на выполнение операции по часам магазина.

orderId

long

Номер транзакции отложенного перевода, выдается Яндекс.Кассой в параметре invoiceId .

ym_merchant_receiptstring

Данные для формирования чека в формате JSON (так же, как в платежной форме).

Параметр передается и является обязательным, если:

  • вы настроили взаимодействие со своей онлайн-кассой через Яндекс.Кассу и передаете в платежной форме данные для формирования чека;
  • у отменяемой операции на этапе авторизации не был передан чек.

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

В ответ приходят параметры, общие для всех типов запросов на исполнение финансовых операций.

Примеры

Пример запроса
requestDT=2011-07-02T20:38:00.000Z&orderId=12345
Пример ответа
<cancelPaymentResponse 
         orderId="12345"
         status="0" error="0"
         processedDT="2011-07-02T20:38:01.000Z"
         />

Смотрите также

Сценарий отложенной оплаты

Правила обработки запросов

Коды ошибок

Типы данных