1.

Api Authorization

2. Отправка данных о покупке

POST SERVER_URL/order-data
BODY:
{
"traderId":"",
"sourceId":"",
“cashdeskId”:””,
"cardId":"",
"order":{
"orderNumber":"002121",
"fiscalNumber":””,
"orderTime":"2021-07-21T18:00:15.000",
"items":[
{
"name":"",
"code":"",
"category":"",
“discounts”:[
{
“src”: “xc” | ...
“type”: “percent” | “amount”
“value”: 1.00
}
],
“qty”:1.00,
“price”:1.00,
“priceWithDiscount”:1.00
}
],
“totalPrice”:1.00,
“totalPriceWithDiscount”:1.00,
“percentTax”:1.00,
“totalTax”:1.00,
“paymentForm”: “card” | “cash” | ...
}
},
где

Обязательное Описание Тип

traderId + Идентификатор Строка /UUID
торговой сети. Будет
выдан вместе с
данными для
 авторизации.

sourceId + Идентификатор точки Строка

продажи,
принадлежащей
торговой сети. Будет
получен после
регистрации новой
точки

cashdeskId + Идентификатор Строка

кассы

cardId + Идентификатор КХ Строка

order + Обьект заказа Обьект

orderNumber + Номер заказа / чека Строка

fiscalNumber + Фискальный номер Строка

кассового чека

orderTime + Время Строка/Дата

заказа/покупки время

items + Перечень товаров в Массив

заказе обьектов Item

name + Название товара Строка

code + Штрихкод товара. Строка

Обязателен при
наличии

category + Категория товара Строка

discounts +/- Перечень скидок Массив

объектов
discount

src +/- Источник скидки Строка

type +/- Тип скидки (%/число) Строка

value +/- Значение скидки Число

qty + Количество единиц Число

товара / вес товара

price + Цена Число

priceWithDiscount +/- Цена со скидкой Число

totalPrice + Общая цена Число

 totalPriceWithDisco +/- Общая цена со Число
unt скидкой

percentTax + % ПДВ Число

totalTax + Сумма ПДВ Число

paymentForm + Форма оплаты Строка

RESPONSE:

{
"status":"”OK | ERROR | INVALID_DATA | NOT_AUTHORIZED |
SOURCE_BLOCKED”",
"requestId":""
"errors":[
{
"field":"",
"message":"",
"code":
}
]
}
где -

Обязательное Описание Тип

status + Результат Строка
выполнения
запроса

requestId + Идентификатор Строка/UUID

запроса

errors - В случае ошибки Массив обьектов

содержит
дополнительную
информацию

field + Json Key который Строка

вызвал ошибку.

message + Текст для отладки Строка

code + Код ошибки Число

3. Валидация карты

POST SERVER_URL/validate

Request:
{
“value”:”xc12345678”
}

Response:
{
“status”: ”OK”,
“cardStatus”:”VALID” // “INVALID_CARD” // “BLOCKED”
}