4.3.1. Описание спецификации REST API сервиса ПСП 2.0

Спецификация API ПСП 2.0 опубликована по адресу: https://api2.doc-psp.sicmt.ru/.

Метод получения балансов квот субсидированных билетов (v2/balance) может вызываться информационным ресурсом Участника взаимодействия при выполнении любых операций в ходе осуществления перевозок.

По каждой категории квотирования рассчитывается свой баланс квоты, содержащий 4 счетчика:

- счетчик доступных единиц квотирования (available);

- счетчик оформленных единиц квотирования (issued);

счетчик сданных единиц квотирования (refund);

- счетчик использованных единиц квотирования (used).

Количество доступных (available) единиц квотирования зависит от числа использованных единиц квотирования и вычисляется по формуле:

available = 4 used (0, если разность отрицательная), где число "4" - максимально возможное число единиц квотирования при оформлении 4 (четырех) билетов в одном направлении (или 2 (двух) билетов в направлении туда и обратно, или 2 (двух) билетов в одном направлении и 1 (одного) билета в направлении туда и обратно).

Все балансы квот по 8 категориям квотирования, указанным в Приложении 1 к настоящему Регламенту, включают в себя 8 * 4 = 32 счетчика.

Для запросов баланса имеется обязательное поле "год расчета балансов квот", в котором задается календарный год, для которого рассчитываются балансы квот пассажира.

В методе API ПСП 2.0 расчет балансов квот осуществляется только по одному ДУЛ пассажира, полученному в запросе.

Метод изменения балансов квот (v2/balance/change) в API ПСП 2.0 вызывается для учета операций по передаче сведений о пассажире и субсидированном билете в онлайн-режиме, приближенном к реальному времени, по факту следующих событий:

- оформление билета - передается операция с типом "issued";

- возврат билета - передается операция с типом "refund";

- обмен билета - передаются операции двух типов: "refund" для предыдущего оформленного билета и "issued" для нового билета, выпущенного в процессе обмена;

- факт перевозки пассажира (использовано) - передается операция с типом "used";

- изменение параметров оформленного билета без изменения его номера (ревалидация) - передается операция с типом "edit".

Операция с типом "edit" по составу передаваемых данных идентична операции оформления ("issued") и выполняет для билета замену данных операции оформления. При этом, в отличие от операции оформления ("issued"), для билета допускается несколько операций редактирования - при расчете балансов квот будет использоваться последний по времени редактирования вариант билета. Так как операция редактирования заменяет билет целиком, то по аналогии с операцией оформления она должна содержать сразу все сегменты билета.

Операции использования и возврата для билета должны быть уникальны по пунктам и времени отправления сегментов билета. В противном случае операция будет отклонена в ПСП как дубликат. Поддерживаются частичные возврат и использование билетов, под которыми понимается выполнение операций с входящими в билет сегментами по отдельности.

Метод загрузки списка операций (v2/balance/batch) в API ПСП 2.0 вызывается для учета списков операций по передаче сведений о пассажирах и субсидированных билетах в отложенном режиме.