Оплат ы
LIFE POS API позволяет получать, хранить и обрабатывать все данные об оплатах, в том числе для последующей фискализации.
Создать оплату
За движения денежных средств в LIFE POS API отвечает объект Сессия. Сессия — это любое ваше взаимодействие с покупателем, в рамках которого передаются деньги или позиции номенклатуры. Оплата продавцу и отгрузка товара покупателю — это прямые сессии, а возврат — обратная. Подробнее о сессиях
Чтобы создать новую прямую сессию, отправьте POST-запрос по адресу:
base_url
— адрес сервиса. Возможные значения:https://api-dev.life-pos.ru
— тестовый API,https://api.life-pos.ru
— рабочий API.
Получение информации об оплате
Чтобы получить список всех сессий, связанных с пр одажей, отправьте GET-запрос по адресу:
{base_url}/orgs/{org_guid}/deals/sales/{deal_guid}/sessions
Данные выводятся постранично, по 20 записей на страницу. Если нужно получить данные второй страницы, возьмите из ответа значение параметра next_page_token
и отправьте новый запрос, передав это значение в параметре page_token
. Продолжайте до тех пор, пока параметр next_page_token
не придёт пустым.
Например, вы запросили данные о сотрудниках и получили такой ответ:
“next_page_token”: “OdDEFa2CzpYdp1CmlO9s9mjBn4NkUZB3CXKOtNfQWM0”,
“page_number”: 1,
“pages_total”: 2,
“items_per_page”: 20,
“items_total”: 27,
В ответе представлены только записи 1–20. Чтобы посмотреть записи с 21 по 27, отправьте новый GET-запрос, указав page_token=“OdDEFa2CzpYdp1CmlO9s9mjBn4NkUZB3CXKOtNfQWM0”
.
В запросе есть необязательный параметр selection
. Это фильтр сессий по их статусу. Если параметр не передан, по умолчанию используется значение alive_only
, то есть в ответе прид ут только данные сессий, не перенесённых в архив. Чтобы посмотреть весь список сессий или только архивные данные, укажите значение all
или archived_only
соответственно.
Чтобы получить данные конкретной сессии, отправьте GET-запрос по другому адресу:
{base_url}/orgs/{org_guid}/deals/sales/{deal_guid}/sessions/direct/{session_guid}
session_guid
– идентификатор сессии. Можно получить в списке сессий по продаже.
Если покупатель платил по карте, можете также получить данные транзакции. Для этого отправьте GET-запрос по адресу:
{base_url}/orgs/{org_guid}/terminals/{method}/{terminal_guid}/transactions/{transaction_guid}
method
— способ оплаты. Возможные значения:bank
— банковская карта,quick-payments
— СБП.transaction_guid
— идентификатор транзакции. Передаётся в документе оплаты.
Описание запроса для банковской карты Описание запроса для СБП
Изменение информации об оплате
Когда статус оплаты изменится, нужно обновить информацию о ней. Например, когда оплата будет фискализирована, вы можете добавить в поле fiscal_documents
ссылку на чек.
Чтобы изменить информацию об оплате, отправьте PATCH-запрос по адресу:
{base_url}/orgs/{org_guid}/deals/sales/{deal_guid}/sessions/direct/{session_guid}
Удаление и восстановление информации об оплате
Вы можете отправить информацию об оплате в архив. Полностью информация не удаляется. Она исчезает из вашего интерфейса управления заказами, но продолжает храниться на сервере LIFE POS. Её можно восстановить, если она снова понадобится.
Чтобы удалить информацию об оплате, отправьте DEL-запрос по адресу:
{base_url}/orgs/{org_guid}/deals/sales/{deal_guid}/sessions/direct/{session_guid}
Восстановить информацию об оплате можно POST-запросом:
{base_url}/orgs/{org_guid}/deals/sales/{deal_guid}/sessions/direct/{session_guid}:unarchive
Вот и всё, что нужно знать о работе с оплатами. В следующей статье поговорим о транзакциях.