Идентификатор в системе SWiP. Касса не должна его ставить. Касса создает заказ, посылая объект заказа (Order). Обратно приходит так же объект Order c установленным полем id. Дальше это поле используется в запросах GET.

Идентификатор заказа у мерчанта.

Идентификатор сессии (текстовое значение зашифрованное в QR-коде). Если касса работает в режиме ресторана, то QR-код берется из ответа сервера на запрос создания заказа.

Authorization

Bearer 8c6b8b64-6815-6084-0a3e-178401251b68

Токен передает сотрудник SWiP после подключения мерчанта.

X-Merchant-ID

ABCD

Значение передает сотрудник SWiP после подключения мерчанта. Сейчас используются четырехбуквенные коды, в дальнейшем значения могут расшириться.

X-Store-ID

Shipilovo

Идентификатор торговой точки, который передает сотрудник SWiP после подключения мерчанта. Это значение берется из системы мерчанта: либо реальный идентификатор магазина, либо, если его невозможно получить из кассы, значение из настроек плагина SWiP.

X-Cash-ID

1231

Номер кассы в системе мерчанта.

На стороне SWiP идентификатор не проверяется и не регистрируется. В дальнейшем используется для статистики по торговым точкам.

Api-Version*

3

Версия API.

200

Успешный запрос.

400

Неправильный запрос из-за нарушения правил взаимодействия с API.

bad_request

401

Неудачная авторизация.

unauthorized

403

Доступ запрещен.

forbidden

404

Ресурс по указанному id не был найден в системе SWiP.

not_found

405

Используется запрещенный или неподдерживаемый метод.

method_not_allowed

429

Отправлено слишком много запросов за короткий промежуток времени.

too_many_request

500

Внутренняя ошибка сервера.

internal_server_error

1

INTERNAL SERVER ERROR
Внутренняя ошибка сервера.

2

AUTHENTICATION ERROR
Неудачная аутентификация.

4

ACCESS DENIED
Доступ запрещен.

5

VALIDATION FAILED
Некорректная валидация.

6

ILLEGAL STATE
Ошибка неправильного состояния текущей операции.

7

METHOD NOT SUPPORTED
Метод не поддерживается.

8

DUPLICATE
Дублицирование данных.

9

NOT FOUND
Ресурс не найден.

10

UNSUPPORTED MESSAGE
Неподдерживаемое сообщение.

11

ORDER FLOW VIOLATION
Нарушение процесса обработки заказа.

12

SMS CODE EXPIRED
Истек срок действия СМС-кода.

13

OPERATION TIMED OUT
Истекло время ожидания операции.

14

DOESNT MATCH
Несовпадение данных.

15

PAYMENTS BLOCKED
Платежи заблокированы.

16

TOKEN EXPIRED
Истек срок действия JWT токена.

17

JWT TOKEN ERROR
Ошибка процессинга токена.

18

CONCURRENT PAYMENT ERROR
Ошибка из-за осуществления параллельных платежей.

19

BANK PAYMENT ERROR
Ошибка оплаты банка.

20

PAYMENT CARD BLOCKED
Платежная карта заблокирована.

21

ACCOUNTING ERROR
Ошибка в расчетах.

22

REQUEST LIMIT EXCEEDED
Превышен лимит количества запросов.

23

EXTERNAL SYSTEM ERROR
Внешняя ошибка системы.

24

CASHBACK PAYMENT ERROR
Ошибка при оплате кэшбэком.

25

OPERATION IN PROGRESS
Операция находится в процессе выполнения.

26

CUSTOMER DUPLICATE PIN
Дублицирование ПИН-кода клиента.

27

REVERSE UNAVAILABLE
Отмена оплаты недоступна.

28

ORDER ALREADY EXISTS
Заказ уже существует.

29

ORDER ALREADY REFUNDED
Возврат по заказу уже выполнен.

30

ORDER ALREADY CONFIRMED
Подтверждение оплаты заказа уже выполнено.

31

ORDER NOT PAID
Ордер не оплачен.

32

EXCESS TOTAL AMOUNT
Попытка вернуть сумму превышающую сумму заказа. 

id

UUID

Идентификатор заказа в системе SWiP.

merchantOrderId*

string

Идентификатор заказа в системе мерчанта.
(Если мерчант для идентификации заказов использует формат UUID, то это значение может быть использовано для идентификатора заказа в системе SWiP).

apiVersion

integer

Версия API, по которой оплачен заказ.

authorizationCode

string

Авторизационный код платежа.

cashback

double

Сумма кэшбэка.

closeAmount*

double

Сумма, которую касса считает к закрытию заказа. Значение присутствует после закрытия заказа.

customerId

string

Идентификатор клиента оплатившего заказ. Значение присутствует после закрытия заказа.

discountCard

string

Номер дисконтной карты клиента.

error

string

Текстовое описание последней ошибки при оплате заказа.

merchantCash

string

Номер кассы или группы касс на стороне мерчанта (ставить не нужно, берется из заголовков HTTP-запроса).

merchantCashier*

string

Имя кассира.

merchantCashierId*

string

Идентификатор кассира. Применимо к кассам, которые проставляют этот параметр.

merchantCategory

string

Описание сферы деятельности мерчанта.

merchantCommission

double

Внешняя комиссия мерчанта.

merchantDiscount

double

Скидка, которую предоставляет мерчант.

merchantId

string

Идентификатор мерчанта в системе SWiP.

merchantName

string

Название мерчанта.

merchantOrderNumber*

string

Номер заказа в системе мерчанта (обычно печатается в чеке).

merchantProfileImageId

string

Идентификатор изображения в профиле мерчанта.

merchantStore

string

Идентификатор торговой точки (ставить не нужно, берется из заголовков HTTP-запроса).

orderNumber

string

Номер заказа в банке-эквайере.

orderStatus

OrderStatus

Статус заказа. Возможные значения: OPEN, CLOSED, LOYALTY_CALCULATION.

paid

double

Сумма, оплаченная клиентом через приложение. Значение присутствует после подтверждения оплаты банком.

pan

string

Маскированый номер карты.

paymentMethod

PaymentMethod

Способ оплаты. Возможные значения: CARD, CREDIT, CASH.

paymentSystem

PaymentSystem

Платежная система. Возможные значения: MIR, AMEX, VISA, MASTERCARD, MAESTRO.

purchases

object

Список покупок.

refunded

double

Сумма возврата по заказу.

rrn

string

Уникальный идентификатор банковской транзакции, который назначается банком Эквайером при инициализации платежа.

saleDate*

long

Время продажи в системе мерчанта (в миллисекундах с 01.01.1970). Совпадение даты создания и даты, которая будет напечатана на чеке не обязательно.

sessionCode*

string

QR-код.
Если поле будет отправлено пустым, то сервер SWiP сгенерирует его значение.
В случае оплаты через Selfie2Pay это поле заполнять не надо.

slip

string

Форматированный текст (80 символов в ширину) с банковской информацией о платеже.

swipDiscount

double

Скидка (сумма баллов и дисконта), которую предоставляет SWiP.

terminalNo

string

Номер банковского терминала.

total*

double

Сумма покупки с учетом скидки.

totalOriginal*

double

Сумма покупки без скидки.

unconfirmed

double

Сумма, оплаченная клиентом через приложение, но не подтвержденная кассой (paid>=unconfirmed).

id

UUID

Идентификатор товара.
Если мерчант для идентификации товаров использует UUID, то он может быть использован в качестве id. Если нет, то сервер SWiP генерирует UUID.                                   

productId

string

Артикул (идентификатор) товара в системе мерчанта.

name

string 

Название товара.

quantity

double

Количество (штук, килограмм, литров).

merchantDiscount

double

Скидка, предоставляемая мерчантом.
Поле заполняется после обновления заказа, если был получен статус заказа LOYALTY_CALCULATION.

price 

double

Цена.

amount

double

Стоимость (price * quantity).

unit

Unit

Единицы измерения (LITERS, KILOGRAMS, PIECES).

sessionCode

string, необязательный

Текстовое значение QR-кода.
Касса может присылать какое-либо значение в этом поле. Если поле будет отправлено пустым, то сервер SWiP сгенерирует его значение.
В случае оплаты через Selfie2Pay это поле заполнять не надо.

merchantOrderId

string, обязательный

Уникальный идентификатор заказа у мерчанта.
(Если мерчант для идентификации заказов использует формат UUID, то это значение может быть использовано для идентификатора заказа в системе SWiP).

merchantOrderNumber

string, необязательный

Номер заказа в системе мерчанта (обычно печатается в чеке).

merchantCashier

string, обязательный

Имя кассира.

merchantCashierId

string, необязательный

Идентификатор кассира. Применимо к кассам, которые проставляют этот параметр.

saleDate

long, обязательный

Время продажи в системе мерчанта (в миллисекундах с 01.01.1970). Совпадение даты создания и даты, которая будет напечатана на чеке не обязательно.

total

double, обязательный

Сумма покупки с учетом скидки.

totalOriginal

double, обязательный

Сумма без скидки.

purchases

class, обязательный

Список покупок.

id

UUID, необязательный

Идентификатор товара.
Если мерчант для идентификации товаров использует UUID, то он может быть использован в качестве id. Если нет, то сервер SWiP генерирует UUID.                                   

productId

string, необязательный

Артикул (идентификатор) товара в системе мерчанта.

name

string, обязательный 

Название товара.

quantity

double, обязательный

Количество (штук, килограмм, литров).

merchantDiscount

double, необязательный

Скидка, предоставляемая мерчантом.
Поле заполняется после обновления заказа, если был получен статус заказа LOYALTY_CALCULATION.

price 

double, обязательный

Цена.

amount

double, обязательный

Стоимость (price * quantity).

unit

Unit, необязательный

Единицы измерения (LITERS, KILOGRAMS, PIECES).

sessionCode

string, обязательный

Текстовое значение QR-кода.

Строка длиной от 1 до 100 символов.

merchantOrderId

string, обязательный

Уникальный идентификатор заказа у мерчанта.

Формат UUID.

merchantOrderNumber

string, обязательный

Номер заказа в системе мерчанта.

Наличие только цифр.

merchantCashier

string, обязательный

Имя кассира.

Строка длиной от 0 до 50 символов.

merchantCashierId

string, обязательный

Идентификатор кассира.

Строка длиной от 0 до 50 символов.

saleDate

long, обязательный

Время продажи в системе мерчанта (в миллисекундах с 01.01.1970).

Ненулевое значение.

total

double, обязательный

Сумма покупки с учетом скидки.

Ненулевое значение.

totalOriginal

double, обязательный

Сумма без скидки.

Ненулевое значение.

purchases

class, обязательный

Список покупок.

Ненулевое значение, в списке должен быть минимум 1 объект.

id

string, обязательный

Уникальный идентификатор заказа в системе SWiP.

id

string, обязательный

Уникальный идентификатор заказа в системе SWiP.

OPEN

Заказ открыт.

CLOSED

Заказ закрыт.

LOYALTY_CALCULATION

По заказу проведен расчёт внешней лояльности. Необходимо выполнить обновление заказа.

id

string, обязательный

Уникальный идентификатор заказа в системе SWiP.

merchantDiscount

double, обязательный

Скидка, которую предоставляет мерчант.

merchantPoints

double, обязательный

Баллы для списания, которые предоставляет мерчант.

purcases

object, обязательный

Список покупок.

total

double, обязательный

Сумма покупки с учётом скидки.

id

string, обязательный

Уникальный идентификатор заказа в системе SWiP.

amount

double, обязательный

Сумма, которую касса передает к закрытию заказа.

id

string, обязательный

Уникальный идентификатор заказа в системе SWiP.

from

queryParam, long

Дата начала периода (в миллисекундах с 01.01.1970).

to

queryParam, long

Дата окончания периода (в миллисекундах с 01.01.1970).

amount

double, обязательный

Сумма возврата.

merchantOrderId

string, обязательный

Идентификатор заказа в системе мерчанта.

amount

double, необязательный

Сумма отмены оплаты.

merchantOrderId

string, обязательный

Идентификатор заказа в системе мерчанта.

id

string, обязательный

Уникальный идентификатор заказа в системе SWiP.

amount

double, необязательный

Сумма, которую касса передает к отмене.

settingName

string, обязательный

Название настройки (QR).

settingValue

string, обязательный

Значение настройки (текстовое значение QR-кода).

settingName

string, обязательный

Название настройки (QR).

POST

/orders

order

order

Чтобы отправить заказ на оплату, необходимо создать объект заказа - Order. Он содержит всю необходимую информацию для проведения оплаты. В ответ на запрос придет тот же заказ с проставленными полями: id - SWiP orderid, sessionCode. Если sessionCode был отправлен пустым, то обратно вернется заполненное поле, его надо напечатать в пречеке или показать на экране (кассовом) покупателю.

GET

/orders/{id}

id

order

Запрос позволяет получить информацию о текущем состоянии заказа по его уникальному идентификатору.

GET

/orders/{id}/status

id

Вызывает статус оплаты на сервере SWiP.

POST

/orders/{id}/actions/close

id

{"amount":50.0}

order

Вызывает метод закрытия заказа.

POST

/orders/{id}/actions/confirm-and-close

id

order

Подтверждает и закрывает заказ.

GET

/orders

list<orders>

Запрашивает список заказов за текущий день

POST

/orders/{id}/actions/close

id

{"amount":0.0}

Отменяет неоплаченный заказ.

POST

/refunds

Возвращает успешно завершенный платеж по уникальному идентификатору заказа. Создание возврата возможно только для заказов в статусе CLOSED. Можно возвращать оплату по заказу полностью или частично.

POST

/reverses

Отменяет оплату для заказов в статусе CLOSED. Если сделать отмену оплаты уже невозможно, то будет возвращаться ошибка с кодом 27.

PUT

/merchant-settings/{settingName}

settingName

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

Метод для сохранения настроек кассы на сервере. На данный момент используется для сохранения QR-кода.

GET

/merchant-settings/{settingName}

settingName

Этот метод является опциональным и необходим, если настройки кассы были сохранены на сервере.

Запрашивает на сервере значение прикрепленного к кассе QR-кода.