Retrieving Yandex Pay Order Information

Returns the current status of the Yandex Pay order and the corresponding payments.

For scenario using this method, please see “Payment via Yandex Pay“

Request

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

Path Parameters

Parameter	Required	Type	Description
siteId	Yes	string	Merchant site identifier
orderUid	Yes	string	Unique identifier of the original Yandex Pay order request in the merchant’s information system: orderUid value from the response to the Yandex Pay order generation request

Headers

Header	Required	Type	Description
Authorization	Yes	string	API access key. Bearer [access-token]
Accept	No	string	Response content. application/json

Request Example

Retrieving Yandex Pay order information

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

Response

See also HTTP error codes

Successful Response Parameters

Parameter	Required	Type	Description
orderUid	Yes	string	Yandex Pay order creation request identifier
orderStatus	Yes	string	Yandex Pay order status
amount	Yes	object	Operation amount info
paymentUrl	Yes	string	URL of the payment link of the Yandex Pay order
createdOn	Yes	string	Date and time of creation of the Yandex Pay order in ISO8601 format
payments	No	array of objects	Yandex Pay order payments information

Yandex Pay order payments information

Yandex Pay payments information is transmitted in payments object of the response.

Parameter	Required	Format	Description
paymentUid	Yes	string	Payment identifier. This identifier is used to retrieve payment transaction details via API and create a refund via API
paymentStatus	Yes	string	Current payment status

Error Parameters

Parameter	Required	Type	Description
serviceName	Yes	string	Name of the service that produced the error
errorCode	Yes	string	Error code
description	Yes	string	Error description for the merchant
userMessage	Yes	string	Error description for the customer
dateTime	Yes	string	Error date and time
traceId	Yes	string	Error Log unique ID

Response Examples

Successful responseResponse with error 4xxResponse with error 5xx

{
  "orderUid": "Test012",
  "orderStatus": "PAYED",
  "amount": {
    "currency": "RUB",
    "value": "6.00"
  },
  "paymentUrl": "https://sandbox.pay.ya.ru/l/testtest",
  "payments": [
    {
      "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"
}