API ЮKassa
Помощь
Подключить ЮKassa
Финансовые операции
С помощью MWS магазин может совершать возвраты, подтверждать и отменять отложенные платежи, а также повторять платежи банковской картой или через Mir Pay (если плательщик на это согласился). Конкретному магазину могут быть доступны не все запросы. Это зависит от особенности реализации данного протокола и от условий договора с ЮKassa.
Формат взаимодействия
Адрес сервера для вызова операции
https://shop.yookassa.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.
Общие параметры ответа
Ответы ЮKassa на все типы запросов на исполнение финансовых операций содержат одинаковый набор параметров:
ПараметрТипОписание
statusintРезультат выполнения операции. По значению этого поля магазин должен принимать решение о состоянии запроса (см. раздел Коды состояний запроса).
errorintКод ошибки выполнения запроса (см. раздел Коды ошибок). Является дополнительной расшифровкой к полю status. Опциональное поле.
clientOrderIdClientTransactionNumberКопия параметра clientOrderId запроса. Используется для финансовых операций.
processedDTdateTimeВремя обработки запроса по часам ЮKassa.
techMessagestringОпциональное поле. Может содержать дополнительный поясняющий текст к ответам сервера. Этот текст содержит техническую информацию и не должен отображаться в каком-либо интерфейсе магазина.
Безопасность
Магазин и ЮKassa взаимодействуют по протоколу HTTPS. Для работы с MWS магазину необходимо получить сертификат X.509, выданный удостоверяющим центром ЮMoney, с помощью которого магазин будет формировать запросы к ЮKassa.
Что почитать еще
Коды состояний запросаКоды ошибокЗапрос возврата успешного переводаHTTP-коды ответа