Метод предназначен для поиска форм оплаты в ЮMoney по реквизитам организации.
Формат запроса
GET /api/showcase-search?query=<запрос>&records=<количество> HTTP/1.1 Host: yoomoney.ru Accept-Language: <lang>
Параметры URL запроса:
Параметр | Тип | Описание |
---|---|---|
query | string | Поисковый запрос, слово или фраза. |
records | int | Максимальное количество записей в выдаче метода. |
Запрос может содержать следующие HTTP-заголовки:
Заголовок | Описание |
---|---|
Accept-Language | Код языка, на котором клиент хочет получить описание формы в соответствии с RFC-5646: Tags for Identifying Languages, IANA Language Subtag Registry. Возможные значения:
По умолчанию: ru |
Пример запроса реквизитов по строке «Петроэлектросбыт»
GET /api/showcase-search?query=Петроэлектросбыт&records=3 HTTP/1.1 Host: yoomoney.ru Accept: */*
Параметр | Тип | Описание |
---|---|---|
error | string | Код ошибки. Передается при ошибке выполнения запроса. |
result | array | Список результатов запроса. |
nextPage | boolean | Предикат, определяющий существование записей свыше запрашиваемого лимита. |
Элемент
result
содержит:Параметр | Тип | Описание |
---|---|---|
id | int | Идентификатор формы оплаты (pattern_id ). |
title | string | Наименование получателя. |
url | string | Адрес отправки данных формы оплаты. |
params | object | Набор предзаполненных полей первого шага форма оплаты. |
format | string | Формат формы оплаты. Возможные значения: json Может отсутствовать. Запросить описание формы можно только тогда, когда format равен json . |
Пример ответа
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Content-Length: 454 { "result": [ { "id":5670,"title":"Петроэлектросбыт" }, { "id":5551, "title":"ЗАО ПЕТРОЭЛЕКТРОСБЫТ", "url":"https://yoomoney.ru/api/showcase/validate/5551/step_INN_3038", "params": { "supplierInn":"" }, "format":"json" }, { "id":5551, "title":"ЗАО Петроэлектросбыт", "url":"https://yoomoney.ru/api/showcase/validate/5551/step_INN_3038", "params":{ "supplierInn":"7812013775" }, "format":"json" } ], "nextPage":"false" }
В случае ошибки выполнения операции возвращается ее код:
Код | Описание |
---|---|
illegal_param_query | Недопустимое значение параметра query :
|
illegal_param_records | Недопустимое значение параметра records :
|