Searching for banking details of organizations

This method is for searching for payment forms in YooMoney using details of the business or organization.

Request

Request format

GET /api/showcase-search?query=<request>&records=<quantity> HTTP/1.1
Host: yoomoney.ru
Accept-Language: <lang>

Request URL parameters:

Parameter	Type	Description
query	string	The search query, word or phrase.
records	int	Maximum number of records in the method output.

The request may contain the following HTTP headers:

Header	Description
Accept-Language	The code of the language that the client wants to get the form description in, conforming to RFC-5646: Tags for Identifying Languages, IANA Language Subtag Registry. Possible values: `ru` — Russian; `en` — English. By default: `ru`

Querying details for the string “PetroElectric”

GET /api/showcase-search?query=PetroElectric&records=3 HTTP/1.1
Host: yoomoney.ru
Accept: */*

Response

Parameter	Type	Description
error	string	Error code. Passed if an error occurred when executing the request.
result	array	List of results.
nextPage	boolean	A predicate that determines whether there are records over the requested limit.

The result element contains:

Parameter	Type	Description
id	int	The payment form ID (`pattern_id`).
title	string	Name of the recipient.
url	string	Address for sending payment form data.
params	object	Set of pre-filled fields from the first step of the payment form.
format	string	Format of the payment form. Possible values: `json` May be omitted. The form description can only be requested when `format` equals `json`.

Response example

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 454

{
  "result":
  [
    {
      "id":5670,"title":"PetroElectric"
    },
    {
      "id":5551,
      "title":"PETROELECTRIC CJSC",
      "url":"https://yoomoney.ru/api/showcase/validate/5551/step_INN_3038",
      "params": {
        "supplierInn":""
      },
      "format":"json"
    },
    {
      "id":5551,
      "title":"PetroElectric CJSC",
      "url":"https://yoomoney.ru/api/showcase/validate/5551/step_INN_3038",
      "params":{
        "supplierInn":"7812013775"
      },
      "format":"json"
    }
  ],
  "nextPage":"false"
}

Error codes

Operation processing error codes:

Code	Description
illegal_param_query	Invalid value for the `query` parameter: parameter omitted; contains an empty string; contains an invalid value.
illegal_param_records	Invalid value for the `records` parameter: parameter omitted; contains a non-number; contains an invalid value (for example, `-1`).