Передача данных о точках пополнения (addDepositionPoints)

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

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

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

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

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

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

Параметр

Тип

Описание

agentId xs:long

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

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

requestId xs:string

Идентификатор операции (запроса). Должен быть уникальным для всех ваших запросов к Яндекс.Деньгам. Рекомендуемые значения: целое положительное число в десятичной системе счисления.

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

points Массив объектов типа DepositionPoint

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

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

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

Параметр

Тип

Описание

id xs:int

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

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

type xs:string

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

  • atm — терминал, банкомат для самостоятельного пополнения кошелька;
  • cashbox — кассовый аппарат в офисе.

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

subagent xs:boolean

Точка пополнения — субагент банковского платежного агент.

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

inn xs:string

ИНН субагента.

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

fee DepositionPointFee

Вознаграждение точки пополнения.

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

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

availabilityType xs:string

Возможные значения:

  • public — свободный доступ к точке пополнения;
  • restricted — ограниченный доступ к точке пополнения, например ограничение по времени работы или необходимость получить пропуск.

Необязательный параметр. Значение по умолчанию: public

address DepositionPointAddress

Адрес точки пополнения. См. Описание вложенных параметров — address

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

office xs:string

Номер офиса.

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

location xs:string

Место расположения терминала или банкомата, например указание этажа и других опознавательных знаков.

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

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

Параметр

Тип

Описание

Вознаграждение точки пополнения (fee)
type xs:string

Вид вознаграждения. Возможные значения:

  • percent — процент от суммы пополнения;
  • rub — фиксированная сумма в рублях.

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

value xs:decimal Размер вознаграждения.

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

Адрес точки пополнения (address) — необходимо передать как минимум один параметр
region xs:string

Наименование региона.

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

regionType xs:string

Тип региона. Возможные значения:

  • а.обл. — автономная область;
  • а.окр. — автономный округ;
  • г — город;
  • г.ф.з. — город федерального значения;
  • край — край;
  • обл. — область;
  • округ — округ;
  • респ. — республика.

Можно использовать полное или сокращенное название типа. Если среди указанных значений нет нужного типа, укажите свой тип полностью, без сокращений.

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

street xs:string

Наименование улицы.

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

streetType xs:string

Тип улицы. Возможные значения:

  • ал — аллея;
  • б-г — берег;
  • б-р — бульвар;
  • вал — вал;
  • взд — въезд;
  • дор — дорога;
  • ззд — заезд;
  • лн — линия;
  • наб — набережная;
  • пер-д — переезд;
  • пер — переулок;
  • пл — площадь;
  • пр-д — проезд;
  • проул — проулок;
  • рзд — разъезд;
  • сквер — сквер;
  • тракт — тракт;
  • туп — тупик;
  • ул — улица;
  • ус — усадьба;
  • ш — шоссе.

Можно использовать полное или сокращенное название типа. Если среди указанных значений нет нужного типа, укажите свой тип полностью, без сокращений.

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

house xs:string

Номер дома.

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

building xs:string

Номер корпуса, строения.

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

buildingType xs:string

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

  • стр — строение;
  • сооружение — сооружение;
  • к — корпус;
  • литер — литер.

Можно использовать полное или сокращенное название типа. Если среди указанных значений нет нужного типа, укажите свой тип полностью, без сокращений.

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

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

<addDepositionPointsRequest 
  requestId="1205600607" 
  agentId="0000001">
  <points>
    <point>
      <id>2</id>
      <type>>atm</type>
      <subagent>true</subagent>
      <inn>7750000000</inn>
      <fee>
        <type>rub</type>
        <value>10</value>
      </fee>
      <availabilityType>public</availabilityType>
      <address>
        <region>Ленинградская</region>
        <regionType>обл</regionType>>
        <area>>Всеволожскийм/area>>
        <areaType>р-н</areaType>
        <city>Кудрово</city>
        <cityType>г</cityType>
        <street>Венская</street>
        <streetType>ул</streetType>
        <house>4</house>
        <building>3</building>
        <buildingType>к</buildingType>
      </address>>
      <office>office</office>
      <location>location</location>
     </point>
  </points>
</addDepositionPointsRequest>

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

В ответ Яндекс.Деньги возвращают информацию о состоянии обработки запроса. Возможные варианты: запрос выполнен или отклонен.

Если статус успешный, отправьте Яндекс.Деньгам запрос checkDepositionPoints, чтобы узнать результаты обработки данных.

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

Параметр

Тип

Описание

requestId xs:string

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

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

status xs:string

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

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

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

error AddDepositionPointsError

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

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

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

Параметр

Тип

Описание

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

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

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

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

pointId xs:int

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

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

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

<addDepositionPointsResponse  
  requestId="1205600607" 
  agentId="0000001"
  status="success" 
/>

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

<addDepositionPointsResponse  
  requestId="1205600607" 
  agentId="0000001"
  status="rejected">
  <error
    code="empty_point_address" 
    pointId="1"
  />
</addDepositionPointsResponse>