Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Параметр

Тип

Описание

settingName

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

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

settingValue

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

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

cashId

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

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

merchantId

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

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

storeId

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

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

Пример тела запроса

Code Block
languagejson
{
  "cashId": "string",
  "merchantId": "string",
  "settingName": "string",
  "settingValue": "string",
  "storeId": "string"
}

Формат ответа

...

HTTP-метод

Путь

Параметры

Тело HTTP-запроса

Ответ

Описание

POST

/orders


order

order

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

GET

/orders/{id}

id


order

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

GET

/orders/{id}/status

id


Code Block
{ 
  "totalOriginal":210.0,
  "total":210.0,
  "paid":0.0,
  "unconfirmed":0.0,
  "refunded":0.0,
  "status":"CLOSED"
}

Вызывает статус оплаты на сервере 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


Code Block
{
  "amount": 100.00,
  "merchantOrderId": ""
}
Code Block
{
  "status": "SUCCESS",
  "slip": "",
  "description": "",
  "code": ""
}

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

POST

/reverses


Code Block
{
  "amount": 100.00,
  "merchantOrderId": ""
}
Code Block
languagejson
{
  "status": "SUCCESS",
  "slip": "",
  "description": "",
  "code": ""
}

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

PUT

/merchant-settings/{settingName}

settingName

Code Block
{
  "cashId": "string",
  "merchantId": "string",
  "settingName": "string",
  "settingValue": "string",
  "storeId": "string"
}
Code Block
{
  "cashId": "string",
  "merchantId": "string",
  "settingName": "string",
  "settingValue": "string",
  "storeId": "string"
}

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

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

GET

/merchant-settings/{settingName}

settingName

Code Block
{
  "cashId": "string",
  "merchantId": "string",
  "settingName": "string",
  "settingValue": "string",
  "storeId": "string"
}

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

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

...