Проверка статуса добавления точки пополнения (checkDepositionPoints)

Запрос позволяет узнать статус добавления или обновления данных о точках пополнения. В запросе необходимо передать ваш идентификатор в Яндекс.Деньгах и уникальный идентификатор операции, который вы использовали в запросе addDepositionPoints.

Параметры запроса

Запрос необходимо отправлять методом POST.

Шаблон адреса для отправки запросов

https://server:port/webservice/deposition/api/checkDepositionPoints

Описание параметров запроса

Параметр

Тип

Описание

agentId xs:long

Ваш идентификатор в Яндекс.Деньгах, выдается при подключении.

Обязательный параметр

requestId xs:string

Уникальный идентификатор операции, который вы использовали в запросе addDepositionPoints.

Обязательный параметр

Пример запроса

<checkDepositionPointsRequest 
  requestId="1205600607" 
  agentId="0000001"
/>

Параметры ответа

В ответ Яндекс.Деньги вернут статус каждой точки пополнения, переданной в запросе addDepositionPoints.

Параметры ответа

Параметр

Тип

Описание

requestId xs:string

Уникальный идентификатор операции, переданный в запросе checkDepositionPoints.

Обязательный параметр

status xs:string

Статус запроса. Возможные значения:

  • success — запрос выполнен, Яндекс.Деньги получили данные о точках пополнения и приступили к их обработке;
  • rejected — запрос отклонен;
  • in_progress — запрос в обработке: данные как минимум одной точки пополнения еще обрабатываются.

Обязательный параметр

error CheckDepositionPointsError

Описание ошибки. См. Описание вложенных параметров — error

Обязательный параметр, если status=rejected

items Массив объектов типа DepositionPointItem

Массив объектов item со статусом обработки данных о точках пополнения. См. Описание объекта item

Если запрос еще обрабатывается (status= in_progress), массив будет пустым. Чтобы узнать результаты обработки, повторите запрос checkDepositionPoints с теми же данными.

Обязательный параметр

Описание вложенных параметров

Параметр

Тип

Описание

Описание ошибки (error)
code xs:string

Код ошибки. Возможные значения:

  • technical_error — техническая ошибка;
  • cannot_parse_xml — ошибка синтаксического разбора XML-документа;
  • cannot_read_crypto_packet — невозможно открыть криптоконтейнер, ошибка целостности пакета;
  • illegal_request_id — идентификатор запроса отсутствует или неверно задан;
  • illegal_agent_id — идентификатор агента отсутствует или неверно задан.

Обязательный параметр

pointId xs:int Идентификатор точки пополнения.

Обязательный параметр, если ошибка связана с точкой пополнения, которую можно идентифицировать

Описание объекта item

Параметр

Тип

Описание

id xs:int

Идентификатор точки пополнения, соответствует id объекта point, переданного в запросе addDepositionPoints.

Обязательный параметр

status xs:string

Статус точки пополнения. Возможные значения:

  • created — точка пополнения добавлена;
  • changed — точка пополнения обновлена;
  • invalid_data — точка не добавлена или не обновлена: переданы некорректные данные.

Обязательный параметр

reason xs:string

Описание ошибки, из-за которой точка не добавлена или не обновлена. Возможные значения:

  • address_not_found — указанный адрес точки не найден;
  • incorrect_inn — ИНН отсутствует или неверно задан.

Обязательный параметр, если item.status=invalid_data

Пример ответа (запрос выполнен успешно)

<checkDepositionPointsResponse   
  requestId="1205600607" 
  status="success">
  <items>
    <item
      id="2" 
      status="changed"
    />
  </items>
  </checkDepositionPointsResponse>

Пример ответа (запрос отклонен)

<checkDepositionPointsResponse  
  requestId="1205600607" 
  agentId="0000001"
  status="success">
  <error
    code="cannot_read_crypto_packet" 
  />
  </checkDepositionPointsResponse>

Пример ответа (запрос в обработке)

<checkDepositionPointsResponse  
  requestId="1205600607" 
  agentId="0000001"
  status="in_progress">
  <items/>
</checkDepositionPointsResponse>