Финансовые операции

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

С помощью MWS магазин может совершать возвраты, подтверждать и отменять отложенные платежи, а также повторять платежи банковской картой (если плательщик на это согласился). Конкретному магазину могут быть доступны не все запросы. Это зависит от особенности реализации данного протокола и от условий договора с Яндекс.Деньгами.

Формат взаимодействия

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

Тестовый сервер: https://penelope-demo.yamoney.ru:8083/

Реальный сервер: https://penelope.yamoney.ru/

Формат запроса

Запросы передаются по протоколу HTTP 1.1 методом POST.

Формат передачи параметров в запросе:

  • каждый параметр передается в формате {ключ}={значение} в теле POST-запроса;
  • MIME-тип: application/x-www-form-urlencoded;
  • кодировка символов: UTF-8.
Формат ответа

Результат выполнения запроса будет возвращен в виде XML-документа в теле ответа на HTTP-запрос. Перечень возможных HTTP кодов ответа представлен в Справочниках.

Документ формируется согласно стандарту XML 1.0 (Fifth Edition):

  • имена элементов и атрибутов чувствительны к регистру
  • MIME-тип: application/xml;
  • кодировка символов: UTF-8.

Общие параметры ответа

Ответы Яндекс.Кассы на все типы запросов на исполнение финансовых операций содержат одинаковый набор параметров:

Параметр

Тип

Описание

status

int

Результат выполнения операции. По значению этого поля магазин должен принимать решение о состоянии запроса (см. раздел Коды состояний запроса).

error

int

Код ошибки выполнения запроса (см. раздел Коды ошибок). Является дополнительной расшифровкой к полю status. Опциональное поле.

clientOrderId

ClientTransactionNumber

Копия параметра clientOrderId запроса. Используется для финансовых операций.

processedDT

dateTime

Время обработки запроса по часам Яндекс.Кассы.

techMessage

string

Опциональное поле. Может содержать дополнительный поясняющий текст к ответам сервера. Этот текст содержит техническую информацию и не должен отображаться в каком-либо интерфейсе магазина.

Параметр

Тип

Описание

status

int

Результат выполнения операции. По значению этого поля магазин должен принимать решение о состоянии запроса (см. раздел Коды состояний запроса).

error

int

Код ошибки выполнения запроса (см. раздел Коды ошибок). Является дополнительной расшифровкой к полю status. Опциональное поле.

clientOrderId

ClientTransactionNumber

Копия параметра clientOrderId запроса. Используется для финансовых операций.

processedDT

dateTime

Время обработки запроса по часам Яндекс.Кассы.

techMessage

string

Опциональное поле. Может содержать дополнительный поясняющий текст к ответам сервера. Этот текст содержит техническую информацию и не должен отображаться в каком-либо интерфейсе магазина.

Безопасность

Взаимодействие магазина и Яндекс.Кассы осуществляется по протоколу HTTPS. Для работы с MWS магазину необходимо получить сертификат X.509, выданный удостоверяющим центром Яндекс.Денег, с помощью которого магазин будет формировать запросы к Яндекс.Кассе.

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

Коды состояний запроса

Коды ошибок

Запрос возврата успешного перевода

HTTP коды ответа