Try it — Payers

Отредактируйте параметры запроса и нажмите Выполнить для отправки запроса на сервер

GetReferenceData: Payers — Плательщики

  • Создано 16.04.2026
  • Обновлено 20.05.2026
  • Endpoint: GetReferenceData
  • Soap-method: Payers
Описание

Функция позволяет получить возможных видах плательщиков (отправитель, получатель, третье лицо), необходимых для использования в других функциях при вызове web-сервиса. 

Параметры запроса
Параметр Тип Обязательно Описание
login string логин
password string пароль
parameters Element список параметров
Описание параметра parameters

Параметр parameters содержит настройки запроса в виде иерархической структуры, соответствующей XML-представлению.

Он должен включать:

Key: строка со значением parameters (обязательное);

List: непустой массив элементов, каждый из которых представляет отдельный параметр и сам является структурой с тремя полями:

  • Key: имя параметра (например, Reference);
  • Value: значение параметра указывающая на то какой parameters описывается;
  • ValueType: тип значения — строка, указывающая тип Value(string, int и т.д.).

Пример одного элемента из List:

<car:List>
   <car:Key>Reference</car:Key>
   <car:Value>Payers</car:Value>
   <car:ValueType>string</car:ValueType>
</car:List>

Каждый такой элемент — независимый узел внутри parameters. Если List отсутствует или пуст — запрос отклоняется.

Иерархия структуры parameters:

parameters → List (массив) → каждый элемент List → KeyValueValueType.

Параметр Тип Обязательно Описание
Reference string Имя справочника, должно быть равно «Payers»
Возвращаемые параметры

Параметр Element в ответе содержит информацию  о возможных плательщиках.

Он включает элементы справочника:

Key: идентификатор справочника, к которому относится запись (например, Payers);

List: контейнер записи справочника, каждая запись соответствует одному типу плательщика.

Каждый блок List описывает тип плательщика в виде структуры Element и содержит в себе:

  • Key: числовой идентификатор типа плательщика (например, 0,1,2);
  • Value: наименование типа плательщика на русском языке;
  • ValueType: тип значения — строка, указывающая тип Value (string, dateTime и т.п.);
  • Fields: атрибуты типа плательщика.

Структура ответа иерархична:

Element → Key List (массив) → каждый элемент List → Key Value +ValueType +Fields → каждый элемент Fields → KeyValueValueType.


Если во время запроса произошла ошибка, информация о ней будет отражена в свойстве Properties (см. метод GetReferenceData: ErrorCodes — Коды ошибок). 

Параметр Тип Обязательно Описание
Key string Код плательщика
Value string Наименование плательщика
Fields Element Другие свойства элемента справочника
Возвращаемые параметры Fields

Блок Fields описывает одно дополнительное поле текущей записи справочника внутри List:

  • Key: имя поля(например, Default);
  • Value:  значение поля (может быть пустым);
  • ValueType: тип значения (string, boolean, и т.д.).
Параметр Тип Обязательно Описание
Default boolean Признак плательщика по умолчанию. Значение true — используется по умолчанию, false — не используется.
Примеры запроса/ответа
<soap:Envelope
  xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
  xmlns:car="http://www.cargo3.ru">
  <soap:Header/>
  <soap:Body>
    <car:GetReferenceData>
      <car:login>test</car:login>
      <car:password>2016</car:password>
      <car:parameters>
        <car:Key>parameters</car:Key>
        <car:List>
          <car:Key>Reference</car:Key>
          <car:Value>Payers</car:Value>
          <car:ValueType>string</car:ValueType>
        </car:List>
      </car:parameters>
    </car:GetReferenceData>
  </soap:Body>
</soap:Envelope>
<soap:Envelope
  xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
  <soap:Body>
    <m:GetReferenceDataResponse
      xmlns:m="http://www.cargo3.ru">
      <m:return
        xmlns:xs="http://www.w3.org/2001/XMLSchema"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <m:Key>Payers</m:Key>
        <m:List>
          <m:Key>0</m:Key>
          <m:Value xsi:type="xs:string">Заказчик</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>Default</m:Key>
            <m:Value xsi:type="xs:boolean">false</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>1</m:Key>
          <m:Value xsi:type="xs:string">Отправитель</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>Default</m:Key>
            <m:Value xsi:type="xs:boolean">false</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>2</m:Key>
          <m:Value xsi:type="xs:string">Получатель</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>Default</m:Key>
            <m:Value xsi:type="xs:boolean">true</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
        </m:List>
      </m:return>
    </m:GetReferenceDataResponse>
  </soap:Body>
</soap:Envelope>