API ЮKassa
Помощь
Подключить ЮKassa
Информационные запросы
Информационные запросы позволяют получить список успешных заказов и список возвратов.
Формат взаимодействия
Адрес сервера для вызова операции
https://shop.yookassa.ru
Формат запроса
Запросы передаются по протоколу HTTP 1.1 методом POST.
Формат передачи параметров в запросе:
  • каждый параметр передается в формате {ключ}={значение} в теле POST-запроса;
  • MIME-тип: application/x-www-form-urlencoded;
  • кодировка символов: UTF‑8.
Формат ответа
Перечень возможных HTTP кодов ответа представлен в Справочниках.
Ответ может быть представлен в формате CSV или XML. Формат ответа определяется входными параметрами запроса outputFormat (формат предоставления результата) и csvDelimiter (разделитель значений для формата CSV).
Ответ в формате CSV
Если в запросе указан формат представления результата CSV, то заголовок и тело ответа представляют собой набор строк, разделенных символами перевода строки. В первой строке ответа содержатся значения полей заголовка результата выполнения запроса. Во второй строке содержится перечень названий свойств заказа в том порядке, в котором в следующих строках будут содержаться значения соответствующих свойств заказа. Каждая строка ответа, начиная с третьей, содержит свойства одного заказа.
В качестве разделителя свойств заказа используется значение параметра запроса csvDelimiter (разделитель значений для формата CSV). Если свойство заказа содержит символ разделителя значений (параметр запроса csvDelimiter) или символ двойной английской кавычки () , то в ответе MWS значение свойства помещается в кавычки (), при этом кавычки, содержащиеся внутри свойства, удваиваются.
Если значение какого-либо свойства не может быть определено (например, время перевода для неоплаченного заказа), то в ответе формата CSV значение этого свойства будет пустым.
Безопасность
Магазин и ЮKassa взаимодействуют по протоколу HTTPS. Для работы с MWS магазину необходимо получить сертификат X.509, выданный удостоверяющим центром ЮMoney, с помощью которого магазин будет формировать запросы к ЮKassa.
Что почитать еще
HTTP коды ответаЗапрос списка успешных платежейЗапрос списка возвратов успешных платежей