Try it — PaymentMethods

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

GetReferenceData: PaymentMethods — Способы оплаты

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

Функция позволяет получить возможные способы оплаты (наличная, безналичная), необходимые для использования в других функциях при вызове 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>PaymentMethods</car:Value>
   <car:ValueType>string</car:ValueType>
</car:List>

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

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

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

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

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

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

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

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

Каждая запись справочника из списка List в виде структуры Element содержит в себе:

  • Key: числовой идентификатор способа оплаты (0,1);
  • 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>PaymentMethods</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>PaymentMethods</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">true</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
        </m:List>
      </m:return>
    </m:GetReferenceDataResponse>
  </soap:Body>
</soap:Envelope>