Versions Compared

Key

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

...

Название

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

Принимаемые значения

Значение по умолчанию

Описание

Merchant_ID

Да

Число


Идентификатор предприятия в системе АПК Ассист

Login

Да

8 - 20 символов


Логин учетной записи в АПК Ассист (лат. буквы и цифры, символ _)

Password

Да

8 - 20 символов


Пароль учетной записи в АПК Ассист (лат. буквы и цифры)

OrderNumber

Да

128 символов


Номер заказа в системе расчетов предприятия.

OrderAmount

Да

Число, 15 цифр (разделители «.», «,»)


Сумма платежа в оригинальной валюте (например, 10.34)

OrderCurrency

Нет

3 символа

Валюта юр.лица или предприятия

Код валюты, в которой указана сумма платежа OrderAmount

OrderComment

Нет

256 символов


Комментарий

Delay

Нет

0 – одностадийный механизм работы

1- двустадийный механизм

0

Признак авторизации кредитной карты при двустадийном механизме работы

Language

Нет

RU - русский,

EN - английский

Язык юр.лица или предприятия

Язык квитанции об оплате

ClientIP

Нет

Максимум 15 цифр, 4 разделителя «.»


IP адрес покупателя

TokenType

Нет

1 – Apple Pay;

2 – Google Pay;

3 – Samsung Pay

1

Идентификатор типа платежного токена

PaymentToken

Нет

JSON


Платежный токен

Lastname

Да

70 символов


Фамилия покупателя

Firstname

Да

70 символов


Имя покупателя

Middlename

Нет

70 символов


Отчество покупателя

Email

Да

128 символа


E-mail покупателя

Address

Нет

256 символов


Адрес покупателя

HomePhone

Нет

64 символа


Домашний телефон покупателя

WorkPhone

Нет

20 символов


Рабочий телефон покупателя

MobilePhone

Нет

20 символов


Мобильный телефон покупателя

Fax

Нет

20 символов


Факс покупателя

Country

Нет

3 символа


Код страны покупателя

State

Нет

3 символа


Код региона покупателя

City

Нет

70 символов


Город покупателя

Zip

Нет

25 символов


Индекс предприятия связи покупателя

isConvert

Нет

0 - не конвертировать в базовую валюту;

1 - не конвертировать при возможности;

2 - всегда конвертировать

1

Флаг конвертации валюты платежа в базовую валюту

Format

Нет

4 – SOAP
5 – JSON

5

Формат выдачи результатов

Signature

Нет

строка


Формируется строка, сшитая из следующих параметров заказа:

Merchant_ID;OrderNumber;OrderAmount;OrderCurrency, разделенных точкой с запятой.

На базе этой строки алгоритмом MD5 формируется дайджест.  Дайджест подписывается закрытым RSA ключом мерчанта. Длина ключа - 1024. Полученная байтовая последовательность является подписью магазина. Подпись передается нам в виде дополнительного параметра, закодированного в виде строки BASE64

RecurringIndicator

Нет

1 –

рекуррентный платеж

0 - обычный платеж

0

Признак рекуррентного платежа

RecurringMinAmount

Нет/Да

Число, 15 цифр (разделители «.», «,»)


Минимальная сумма рекуррентных платежей.

Обязателен при RecurringIndicator = 1

RecurringMaxAmount

Нет/Да

Число, 15 цифр

(разделители «.», «,»)


Максимальная сумма рекуррентных платежей.

Обязателен при RecurringIndicator = 1

RecurringPeriod

Нет/Да

Число, 10 цифр


Периодичность рекуррентных платежей в днях.

Обязателен при RecurringIndicator = 1

RecurringMaxDate

Нет/Да

Строковое представление даты в формате DD.MM.YYYY


Дата окончания рекуррентных платежей.

Обязателен при RecurringIndicator = 1

Chequeitems

Нет/Да**

Строка в формате JSON

Позиции чека согласно разделу «Работа с чеком».

GenerateReceipt

Нет

0 или 1

1

Разрешение формирования фискального чека. При значении параметра 0 формирование фискального чека запрещено для данного заказа.

Tax

Нет

10 символов

Определяется настройкой предприятия "Ставка налога по умолчанию" и используется в режиме без передачи позиций чека (вся сумма должна проводится с одной ставкой).

Идентификатор ставки налога

ReceiptLine

Нет

128 символов

Определяется настройкой предприятия "Шаблон строки чека по умолчанию" и используется в режиме без передачи позиций чека.

Текстовое описание позиции чека, если по чеку проводится одна единственная позиция.

FPMode

Нет

Число

Определяется настройкой предприятия "Признак способа расчета по умолчанию" и используется в режиме без передачи позиций чека.

Признак способа расчета.

TaxationSystem

Нет/Да*

Число

Из настроек предприятия или ККТ

Система налогообложения.

*Если предприятие использует несколько систем налогообложения, передача этого параметра становится обязательной.

**Состав чека (поля с названием, стоимостью за единицу товара/услуги, ставкой налога и способом расчета по каждой позиции) определяется по следующим правилам.

  1. Если в запросе передана структура ChequeItems (см. документ «Работа с чеком»), то формируется чек с количеством позиций по числу переданных в ChequeItems строк, в каждой позиции должны быть обязательно указаны параметры:
  • product и/или name;
  • price;
  • quantity;
  • amount;

при этом:

название каждой из позиций формируется как объединение параметров product и name через пробел (если переданы оба) или как один из параметров product или name соответственно (если передан только один);

если параметры Tax или FPmode не переданы в позициях, то они могут быть переданы в параметрах запроса (в этом случае значения этих параметров будут одинаковыми для всех позиций чека, переданных в ChequeItems);

если параметры Tax или FPmode не переданы в параметрах запроса, то их значения подставляются из настроек предприятия (значения этих параметров будут одинаковыми для всех позиций чека, переданных в ChequeItems);

если настройки предприятия для этих параметров отсутствуют, то обработка запроса завершается с ошибкой (недостаточно данных для выполнения операции).

2.Если в запросе не передана структура ChequeItems, то формируется чек с одной позицией, в которой:

  • название позиции подставляется из параметра ReceiptLine, если он передан в запросе; если параметр ReceiptLine не передан в запросе, то название позиции подставляется из настроек предприятия; если настройки предприятия для этих параметров отсутствуют, то в качестве названия подставляется строка "Оплата заказа";
  • стоимость единицы товара/услуги подставляется из параметра запроса Amount;
  • количество всегда равно 1;

если параметры Tax или FPmode не переданы в параметрах запроса, то их значения подставляются из настроек предприятия;

...

Note

Для фискализации операции оплаты токеном в запросе могут передаваться дополнительные параметры для формирования корректного чека. Описание дополнительных параметров приведено в разделе "Режимы передачи данных чека".


Список параметров ответа:

...