Перейти к содержанию

Создание заказа Яндекс Пэй

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

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

Запрос

POST /payin/v1/sites/{siteId}/yandex-pay/orders

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

Параметр Обязательный Тип Описание
siteId Да string Строковый идентификатор сайта ТСП в QIWI Кассе

Заголовки

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

Параметры тела запроса

Параметр Обязательный Тип Описание
orderUid Да string(256) Уникальный идентификатор запроса в информационной системе ТСП. Уникальность означает, что идентификатор должен отличаться от идентификаторов всех таких ранее созданных запросов в рамках одного siteId
amount Да object Данные о сумме операции
successRedirectUrl Да string(1000) URL для переадресации клиента после успешной оплаты
errorRedirectUrl Да string(1000) URL для переадресации клиента в случае возникновения ошибки во время оплаты, или если срок заказа на оплату истек
ttl Нет number Параметр определяет время, в течение которого пользователь может воспользоваться платежной ссылкой. Время указывается в секундах. Минимальное время - 180 сек. Максимальное время - 86400 сек. По умолчанию - 1800 сек

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

Создание заказа Яндекс Пэй
POST /partner/payin/v1/sites/test-01/yandex-pay/orders HTTP/1.1
Accept: application/json
Authorization: Bearer 5c4b25xx93aa435d9cb8cd17480356f9
Content-type: application/json
Host: b2b-api.qiwi.com

{
  "orderUid" : "Test012",
  "amount" : {
    "value" : "6.00",
    "currency" : "RUB"
  },
  "successRedirectUrl": "https://example.com/redirectUrl",
  "errorRedirectUrl": "https://example.com/redirectUrl",
  "ttl": 180
}

Ответ

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

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

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

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

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

{
  "orderUid" : "Test012",
  "orderStatus": "CREATED",
  "amount": {
    "currency": "RUB",
    "value": "6.00"
  },
  "paymentUrl": "https://sandbox.pay.ya.ru/l/testtest",
  "createdOn": "2026-02-03T15:09:47+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"
}