Получение информации о заказе Яндекс Пэй¶

Запрос возвращает текущий статус заказа Яндекс Пэй для оплаты через Яндекс Пэй и платежа по нему.

Сценарий, в котором используется запрос статуса заказа Яндекс Пэй, см. в статье «Оплата с помощью Яндекс Пэй»

Запрос¶

GET /payin/v1/sites/{siteId}/yandex-pay/orders/{orderUid}

Параметры строки запроса¶

Параметр	Обязательный	Тип	Описание
siteId	Да	string	Строковый идентификатор сайта ТСП в QIWI Кассе
orderUid	Да	string	Идентификатор исходного запроса при создании заказа Яндекс Пэй в информационной системе ТСП: значение `orderUid` из ответа на запрос создания заказа Яндекс Пэй

Заголовки¶

Заголовок	Обязательный	Тип	Описание
Authorization	Да	string	Авторизационные данные. `Bearer [access-token]`
Accept	Нет	string	Тип ответа. `application/json`

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

Запрос информации о заказе Яндекс Пэй

GET /payin/v1/sites/test-01/yandex-pay/orders/Test012 HTTP/1.1
Accept: application/json
Authorization: Bearer 5c4b25xx93aa435d9cb8cd17480356f9
Content-type: application/json
Host: b2b-api.qiwi.com

Ответ¶

См. также список общих HTTP кодов ошибок

Поля успешного ответа¶

Параметр	Обязательный	Тип	Описание
orderUid	Да	string(256)	Идентификатор запроса. Такой же как в параметрах запроса
orderStatus	Да	string	Статус заказа Яндекс Пэй
amount	Да	object	Данные о сумме операции
paymentUrl	Да	string	URL платежной ссылки заказа Яндекс Пэй
createdOn	Да	string	Дата и время создания заказа Яндекс Пэй
payments	Нет	array of objects	Информация о платежах по заказу Яндекс Пэй

Информация о платежах по заказу Яндекс Пэй¶

Информация о платеже по заказу Яндекс Пэй передаётся в объекте payments ответа.

Параметр	Обязательный	Тип	Описание
paymentUid	Да	string	Идентификатор платежа. Данный идентификатор используется для получения информации о платёжной транзакции по методу API и создания возврата по методу API
paymentStatus	Да	string	Текущий статус платежа

Поля ответа с ошибкой¶

Параметр	Обязательный	Тип	Описание
serviceName	Да	string	Имя сервиса, сгенерировавшего ошибку
errorCode	Да	string	Код ошибки
description	Да	string	Описание ошибки для ТСП
userMessage	Да	string	Описание ошибки для отображения покупателю
dateTime	Да	string	Дата и время ошибки
traceId	Да	string	Уникальный ID лога ошибки

Примеры ответов¶

Успешный ответОтвет с ошибкой 4xxОтвет с ошибкой 5xx

{
  "orderUid": "Test012",
  "orderStatus": "PAYED",
  "amount": {
    "currency": "RUB",
    "value": "6.00"
  },
  "paymentUrl": "https://sandbox.pay.ya.ru/l/testtest",
  "payments": [
    {
        "paymentUid": "5fe3450b-5988-33f1-8697-c172b163e63b",
        "paymentStatus": "DECLINED"
    },
    {
      "paymentUid": "8990ebf3-bd71-3493-b606-da383ee502bb",
      "paymentStatus": "COMPLETED"
    }
  ],
  "createdOn": "2026-02-03T13:11:23+03:00"
}

{
  "serviceName" : "payin-core",
  "errorCode" : "validation.error",
  "description" : "Validation error",
  "userMessage" : "Validation error",
  "dateTime" : "2022-03-05T11:49:59.166+03:00",
  "traceId" : "fd0e2a08c63ace83"
}

{
  "serviceName":"payin-core",
  "errorCode":"internal.error",
  "userMessage":"Internal error",
  "description":"Internal error",
  "traceId":"3fb3420ee1795dcf",
  "dateTime":"2020-02-12T21:28:01.813+03:00"
}