Проверка статуса добавления точки пополнения (checkDepositionPoints)
Запрос позволяет узнать статус добавления или обновления данных о точках пополнения. В запросе необходимо передать ваш идентификатор в ЮMoney и уникальный идентификатор операции, который вы использовали в запросе addDepositionPoints.
 
Параметры запроса
Запрос необходимо отправлять методом POST.
 
Адрес для отправки запросов
https://deposit.yoomoney.ru:9094/webservice/deposition/api/checkDepositionPoints
 
Описание параметров запроса
ПараметрТипОписание
agentIdxs:long
Ваш идентификатор в ЮMoney, выдается при подключении.
Обязательный параметр
requestIdxs:string
Уникальный идентификатор операции, который вы использовали в запросе addDepositionPoints.
Обязательный параметр
 
Пример запроса
XML
<checkDepositionPointsRequest
  requestId="1205600607"
  agentId="0000001"
/>
 
Параметры ответа
В ответ ЮMoney вернут статус каждой точки пополнения, переданной в запросе addDepositionPoints.
 
Параметры ответа
ПараметрТипОписание
requestIdxs:string
Уникальный идентификатор операции, переданный в запросе
checkDepositionPoints
.
Обязательный параметр
statusxs:string
Статус запроса. Возможные значения:
  • success
     — запрос выполнен, ЮMoney получили данные о точках пополнения и приступили к их обработке;
  • rejected
     — запрос отклонен;
  • in_progress
     — запрос в обработке: данные как минимум одной точки пополнения еще обрабатываются.
Обязательный параметр
errorCheckDepositionPointsError
Обязательный параметр, если
status=rejected
itemsМассив объектов типа DepositionPointItem
Массив объектов
item
со статусом обработки данных о точках пополнения. См. Описание объекта item
Если запрос еще обрабатывается (
status=in_progress
), массив будет пустым. Чтобы узнать результаты обработки, повторите запрос
checkDepositionPoints
с теми же данными.
Обязательный параметр
 
Описание вложенных параметров
ПараметрТипОписание
Описание ошибки (
error
)
codexs:string
Код ошибки. Возможные значения:
  • technical_error
     — техническая ошибка;
  • cannot_parse_xml
     — ошибка синтаксического разбора XML-документа;
  • cannot_read_crypto_packet
     — невозможно открыть криптоконтейнер, ошибка целостности пакета;
  • illegal_request_id
     — идентификатор запроса отсутствует или неверно задан;
  • illegal_agent_id
     — идентификатор агента отсутствует или неверно задан.
Обязательный параметр
pointIdxs:int
Идентификатор точки пополнения.
Обязательный параметр, если ошибка связана с точкой пополнения, которую можно идентифицировать
 
Описание объекта item
ПараметрТипОписание
idxs:int
Идентификатор точки пополнения, соответствует
id
объекта point, переданного в запросе
addDepositionPoints
.
Обязательный параметр
statusxs:string
Статус точки пополнения. Возможные значения:
  • created
     — точка пополнения добавлена;
  • changed
     — точка пополнения обновлена;
  • invalid_data
     — точка не добавлена или не обновлена: переданы некорректные данные.
Обязательный параметр
reasonxs:string
Описание ошибки, из-за которой точка не добавлена или не обновлена. Возможные значения:
  • address_not_found
     — указанный адрес точки не найден;
  • incorrect_inn
     — ИНН отсутствует или неверно задан.
Обязательный параметр, если
item.status=invalid_data
 
Примеры ответов
Пример ответа (запрос выполнен успешно)
XML
<checkDepositionPointsResponse   
  requestId="1205600607"
  status="success">
  <items>
    <item
      id="2"
      status="changed"
    />
  </items>
  </checkDepositionPointsResponse>
Пример ответа (запрос отклонен)
XML
<checkDepositionPointsResponse  
  requestId="1205600607"
  agentId="0000001"
  status="success">
  <error
    code="cannot_read_crypto_packet"
  />
  </checkDepositionPointsResponse>
Пример ответа (запрос в обработке)
XML
<checkDepositionPointsResponse  
  requestId="1205600607"
  agentId="0000001"
  status="in_progress">
  <items/>
</checkDepositionPointsResponse>
 
Что почитать еще
Формат взаимодействияПередача данных о точках пополненияПорядок формирования списка точек пополнения