Передача данных о точках пополнения (addDepositionPoints)
Запрос позволяет передать ЮMoney данные о точках пополнения кошелька: тип точки пополнения, данные о ее физическом местоположении и другие. Для каждой точки пополнения необходимо задать идентификатор. Он нужен для зачисления переводов, а также для обновления данных о точке пополнения.
 
Параметры запроса
Запрос необходимо отправлять методом POST.
 
Адрес для отправки запросов
https://deposit.yoomoney.ru:9094/webservice/deposition/api/addDepositionPoints
 
Описание параметров запроса
ПараметрТипОписание
agentIdxs:long
Ваш идентификатор в ЮMoney, выдается при подключении.
Обязательный параметр
requestIdxs:string
Идентификатор операции (запроса). Должен быть уникальным для всех ваших запросов к ЮMoney. Рекомендуемые значения: целое положительное число в десятичной системе счисления.
Обязательный параметр
pointsМассив объектов типа DepositionPoint
Данные о точках пополнения. Массив объектов
point
с данными о точках. См. Описание объекта point
Обязательный параметр
 
Описание объекта point
ПараметрТипОписание
idxs:int
Идентификатор точки пополнения.
Обязательный параметр
typexs:string
Тип точки пополнения. Возможные значения:
  • atm
     — терминал, банкомат для самостоятельного пополнения кошелька;
  • cashbox
     — кассовый аппарат в офисе;
  • mobilecashbox
     — мобильная (передвижная) касса.
Обязательный параметр
subagentxs:boolean
Точка пополнения — субагент банковского платежного агента.
Обязательный параметр
innxs:string
ИНН субагента.
Обязательный параметр, если
subagent=true
feeDepositionPointFee
Вознаграждение точки пополнения.
Необязательный параметр
availabilityTypexs:string
Возможные значения:
  • public
     — свободный доступ к точке пополнения;
  • restricted
     — ограниченный доступ к точке пополнения, например ограничение по времени работы или необходимость получить пропуск.
Необязательный параметр. Значение по умолчанию:
public
addressDepositionPointAddress
Адрес точки пополнения. См. Описание вложенных параметров — address
Обязательный параметр
Если
type=mobilecashbox
и
subagent=false
, передавать параметр не нужно. ЮMoney будут использовать адрес юридического лица.
officexs:string
Номер офиса.
Необязательный параметр
locationxs:string
Место расположения терминала или банкомата, например указание этажа и других опознавательных знаков.
Необязательный параметр
 
Описание вложенных параметров
ПараметрТипОписание
Вознаграждение точки пополнения (
fee
)
typexs:string
Вид вознаграждения. Возможные значения:
  • percent
     — процент от суммы пополнения;
  • rub
     — фиксированная сумма в рублях.
Обязательный параметр
valuexs:decimal
Размер вознаграждения.
Обязательный параметр
Адрес точки пополнения (
address
) — необходимо передать как минимум один параметр
regionxs:string
Наименование региона.
Необязательный параметр
regionTypexs:string
Тип региона. Возможные значения:
  • а.обл.
     — автономная область;
  • а.окр.
     — автономный округ;
  • г
     — город;
  • г.ф.з.
     — город федерального значения;
  • край
     — край;
  • обл.
     — область;
  • округ
     — округ;
  • респ.
     — республика.
Можно использовать полное или сокращенное название типа. Если среди указанных значений нет нужного типа, укажите свой тип полностью, без сокращений.
Необязательный параметр
streetxs:string
Наименование улицы.
Необязательный параметр
streetTypexs:string
Тип улицы. Возможные значения:
  • ал
     — аллея;
  • б-г
     — берег;
  • б-р
     — бульвар;
  • вал
     — вал;
  • взд
     — въезд;
  • дор
     — дорога;
  • ззд
     — заезд;
  • лн
     — линия;
  • наб
     — набережная;
  • пер-д
     — переезд;
  • пер
     — переулок;
  • пл
     — площадь;
  • пр-д
     — проезд;
  • проул
     — проулок;
  • рзд
     — разъезд;
  • сквер
     — сквер;
  • тракт
     — тракт;
  • туп
     — тупик;
  • ул
     — улица;
  • ус
     — усадьба;
  • ш
     — шоссе.
Можно использовать полное или сокращенное название типа. Если среди указанных значений нет нужного типа, укажите свой тип полностью, без сокращений.
Необязательный параметр
housexs:string
Номер дома.
Необязательный параметр
houseTypexs:string
Тип дома. Возможные значения:
  • влд
     — владение;
  • д
     — дом;
  • стр
     — строение;
  • двлд
     — домовладение.
Можно использовать полное или сокращенное название типа. Если среди указанных значений нет нужного типа, укажите свой тип полностью, без сокращений.
Параметр по умолчанию принимает значение
д
, если в параметре
house
передан номер дома.
Необязательный параметр.
buildingxs:string
Номер корпуса, строения.
Необязательный параметр
buildingTypexs:string
Тип корпуса, строения. Возможные значения:
  • стр
     — строение;
  • сооружение
     — сооружение;
  • к
     — корпус;
  • литер
     — литер.
Можно использовать полное или сокращенное название типа. Если среди указанных значений нет нужного типа, укажите свой тип полностью, без сокращений.
Необязательный параметр
 
Пример запроса
XML
<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>
        <houseType>д</houseType>
        <building>3</building>
        <buildingType>к</buildingType>
      </address>>
      <office>office</office>
      <location>location</location>
     </point>
  </points>
</addDepositionPointsRequest>
 
Параметры ответа
В ответ ЮMoney возвращают информацию о состоянии обработки запроса. Возможные варианты: запрос выполнен или отклонен.
Если статус успешный, отправьте ЮMoney запрос checkDepositionPoints, чтобы узнать результаты обработки данных.
 
Параметры ответа
ПараметрТипОписание
requestIdxs:string
Уникальный идентификатор операции, переданный в запросе.
Обязательный параметр
statusxs:string
Статус запроса. Возможные значения:
  • success
     — запрос выполнен, ЮMoney получили данные о точках пополнения и приступили к их обработке;
  • rejected
     — запрос отклонен.
Обязательный параметр
errorAddDepositionPointsError
Обязательный параметр, если
status=rejected
 
Описание вложенных параметров
ПараметрТипОписание
Описание ошибки (
error
)
codexs: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
     — не передан адрес точки пополнения.
Обязательный параметр
pointIdxs:int
Идентификатор точки пополнения.
Обязательный параметр, если ошибка связана с точкой пополнения, которую можно идентифицировать
 
Примеры ответов
Пример ответа (запрос выполнен успешно)
XML
<addDepositionPointsResponse  
  requestId="1205600607"
  agentId="0000001"
  status="success"
/>
Пример ответа (запрос отклонен)
XML
<addDepositionPointsResponse  
  requestId="1205600607"
  agentId="0000001"
  status="rejected">
  <error
    code="empty_point_address"
    pointId="1"
  />
</addDepositionPointsResponse>
 
Что почитать еще
Формат взаимодействияПроверка статуса добавления точки пополнения Порядок формирования списка точек пополнения