API Справочники

Работа со справочниками.

Формы оплаты

Метод «getPaymentForms», работает в модели «Common», этот метод позволяет загрузить список форм оплат на украинском и на русском языках. Оплачивать услуги доставки с помощью безналичного расчета могут Клиенты, которые заключили договор с компанией "Новая Почта". Необходимо сохранять копию справочников на стороне клиента и поддерживать ее в актуальном состоянии. Рекомендуется проводить обновление справочников раз в месяц.

URL для входа https://api.novaposhta.ua/v2.0/{format}/ [json or xml]
Формат, обязательно, должен указываться нижним регистром (маленькими буквами), например https://api.novaposhta.ua/v2.0/json/


Доступность: Требует использования API-ключа.

Try it

URL-адрес запроса

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

string

Форматы JSON, XML

(дополнительный)
string

Точка входа для сервисов в формате JSON с форматом ответа JSONP ?callback=?

Заголовки запросов

(дополнительный)
string
Тип формата текста, отправляемого в API.

Текст запроса

Параметр Тип данных Описание
apiKey* string[36] Ваш ключ API 2.0
modelName* string Имя модели
calledMethod* string Имя вызываемого метода
methodProperties string Свойства метода
* Обозначение обязательного параметра

{
"modelName": "Common",
"calledMethod": "getPaymentForms",
"apiKey": "[ВАШ КЛЮЧ]",
"methodProperties": {}
}
<?xml version="1.0" encoding="UTF-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<calledMethod>getPaymentForms</calledMethod>
<methodProperties/>
<modelName>Common</modelName>
</file>

Ответ 200

Всегда возвращает код 200 даже при логических ошибках.


Тело ответа на запрос

Параметр Тип данных Описание
Ref string[36] Идентификатор
Description string[36] Описание на Украинском

{  
   "success":true,
   "data":[  
      {  
         "Description":"Безналичный расчет",
         "Ref":"NonCash"
      },
      {  
         "Description":"Наличный расчет",
         "Ref":"Cash"
      }
   ],
   "errors":[  

   ],
   "warnings":[  

   ],
   "info":[  

   ]
}
<root>
	<success>true</success>
	<data>
		<item>
			<Description>Безналичный расчет</Description>
			<Ref>NonCash</Ref>
		</item>
		<item>
			<Description>Наличный расчет</Description>
			<Ref>Cash</Ref>
		</item>
	</data>
	<errors />
	<warnings />
	<info />
</root>