Versions Compared

Key

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

...

Параметр

Тип

Описание

sessionCode*

UUID

Код сессии, генерируемый клиентом Cash Gate, в частности QR-код (только в режиме фастфуда или магазина).

shortCode

string

Альтернатива QR-кода. 

id

string

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

customerId

string

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

merchantId

string

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

merchantName

string

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

merchantProfileImageId

string

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

merchantCategory

string

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

merchantOrderId*

string

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

merchantOrderNumber*

string

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

merchantStore

string

Идентификатор торговой точки.

merchantCash

string

Идентификатор кассы или группы касс.

merchantCashierId*

string

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

merchantCashier*

string

Имя кассира.

saleDate*

long

Время заказа (в миллисекундах с 01.01.1970).

total*

double

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

totalOriginal*

double

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

cashback

double

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

discount

double

Сумма скидки.

swipDiscount

double

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

purchases

repeated Purchase

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

orderStatus

OrderStatus

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

paymentMethod

PaymentMethod

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

otp

string

Дополнительный идентификатор заказа (one time paid). Необходим для включения камеры.

paid

double

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

unconfirmed

double

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

closeAmount*

double

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

availablePoints

int32

Баллы, доступные для списания.

pointsRate

double

Доля рубля в 1 балле.

pointsAsDiscount

double

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

awardPoints

int32

Количество заработанных баллов в этом заказе.

withdrawPoints

int32

Количество баллов, которые списываются в этом заказе.

paymentWay

PaymentWay

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

apiVersion

integer

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

slip

string

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

authorizationCode

string

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

terminalNo

string

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

pan

string

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

rrn

stringRRN

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

error

string

Последняя ошибка при оплате заказа.

merchantDiscount

double

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

discountCard

string

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

...

Code Block
languagejs
message Order {
    string sessionCode = 1;                       // текстовое значение QR-кода
    string shortCode = 2;                         // альтернатива QR-кода
    string id = 3;                                // идентификатор заказа в системе SWiP
    string customerId = 4;
    string merchantId = 5;                        // идентификатор мерчанта
    string merchantName = 6;                      // название мерчанта
    string merchantProfileImageId = 7;            // идентификатор изображения в профиле мерчанта
    string merchantCategory = 8;                  // категория мерчанта
    string merchantOrderId = 9;                   // уникальный идентификатор заказа у мерчанта
    string merchantOrderNumber = 10;              // идентификатор чека у мерчанта
    string merchantStore = 11;                    // идентификатор торговой точки
    string merchantCash = 12;                     // идентификатор кассы или группы касс
    string merchantCashierId = 13;                // идентификатор кассира
    string merchantCashier = 14;                  // имя кассира
    sint64 saleDate = 15;                         // дата продажи
    double total = 16;                            // сумма (с учетом скидки, если таковая есть у клиента)
    double totalOriginal = 17;                    // сумма (без учета скидки)	
    double cashback = 18;                         // размер кэшбэка
    double discount = 19;                         // сумма скидки
    double swipDiscount = 20;                     // скидка (сумма баллов и дисконта), которую предоставляет SWiP
    repeated Purchase purchases = 21;             // список покупок (товары в чеке)
    double paid = 22;
    double unconfirmed = 23;
    double closeAmount = 24;
    int32 availablePoints = 25;
    string error = 26;
    double pointsRate = 27;
    double pointsAsDiscount = 28;
    int32 awardPoints = 29;
    int32 withdrawPoints = 30;
    PaymentWay paymentWay = 31;
    OrderStatus orderStatus = 32;                 // статус заказа
    PaymentMethod paymentMethod = 33;             // способ оплаты
    int32 apiVersion = 34;                        // версия API
    string otp = 35;                              // дополнительный идентификатор заказа (one time paid)
    string slip = 36;
    string rrn = 37;                              // уникальный идентификатор банковской транзакции
    string authorizationCode = 38;                // авторизационный код платежа
    string terminalNo = 39;                       // номер банковского терминала
    string pan = 40;                              // маскированный номер карты
    double merchantDiscount = 41;                 // скидка, предоставляемая мерчантом
    string discountCard = 42;                     // идентификатор дисконтной карты
}

...