Information requests

Information requests are used for getting a list of successful orders and a list of refunds.

Interaction format

Server address for calling operations

Test server: https://penelope-demo.yamoney.ru:8083/

Real server: https://penelope.yamoney.ru/

Request format

Requests are send over the HTTP 1.1 protocol using the POST method.

Format for passing parameters in the request:

  • Each parameter is passed in {key}={value} format in the body of the POST request.
  • MIME type: application/x-www-form-urlencoded.
  • Encoding: UTF-8.
Response format

Possible HTTP response codes are listed in the References.

The response can be in CSV or XML format. The response format is determined by the request arguments outputFormat (the format for results) and csvDelimiter (the value delimiter for CSV format).

Response in CSV format

If CSV format is specified in the request as the format for results, the response header and body are a set of strings separated by newline characters. The first line in the response contains the values of header fields in the request result. The second line contains a list of names of order properties in the order in which the subsequent lines will contain the values for the corresponding order properties. Each line of the response, beginning from the third line, contains the properties of a single order.

Order properties are separated by whatever value is set for the csvDelimiter request parameter (the value delimiter for CSV format). If an order property contains the delimiter character (the csvDelimiter request parameter) or a double quote character ("), the property value is wrapped in quotation marks (") in the MWS response. Any quotation marks contained inside the property are doubled up.

If the value of a property can't be defined (for example, the time of transfer for an unpaid order), the value of this property will be empty in the response in CSV format.

Security

The merchant and Yandex.Checkout interact over HTTPS. To use MWS, the merchant must get an X.509 certificate from the Yandex.Money certificate authority. The merchant uses the certificate to make requests to Yandex.Checkout.

See also

HTTP response codes

Request for a list of successful payments

Request for a list of refunded successful payments