Skip to main content

Типы данных

НаименованиеОписание
IDСтрока, длиной 24 символа представляющая собой уникальный идентификатор объекта в системе
TimestampПоложительное, целое число состоящее из 13 цифр и определяющее количество миллисекунд, прошедших с полуночи 1 января 1970 года UTC.
AmountПоложительное, целое число, больше нуля представляющее сумму в тийинах.
accountПоле “account” представляет собой JSON объект. Набор полей объекта определяется бизнес – логикой конкретного сервиса мерчанта.

Состояния транзакции (Transaction State)

КодКлючОписание
1CreatedТранзакция успешно создана, ожидание подтверждения (начальное состояние 0).
2CompletedТранзакция успешно завершена (начальное состояние 1).
-1CancelledТранзакция отменена (начальное состояние 1).
-2CancelledCompletedТранзакция отменена после завершения (начальное состояние 2).

BillingAPI

Транзакции (Transaction)

ИмяТипОписание
idStringИдентификатор транзакции
timeTimestampВремя создания транзакции
amountLongСумма платежа в тийинах.
accountaccountСчет покупателя.
create_timeTimestampВремя добавления транзакции в биллинге мерчанта.
perform_timeTimestampВремя проведения транзакции в биллинге мерчанта.
cancel_timeTimestampВремя отмены транзакции в биллинге мерчанта.
transactionStringНомер или идентификатор транзакции в биллинге мерчанта. Формат строки определяется мерчантом.
stateIntegerСостояние транзакции.
reasonIntegerНеобязательное поле, причина отмены транзакции.
receiversReceiver[ ]Список Получателей. Необязательный параметр. В случае если Владелец приложения является Получателем, данное поле следует опустить или присвоить ему значение NULL.

Причина отмены транзакции (Reason)

КодКлючОписание
1ReceiverNotFoundОдин или несколько получателей не найдены или неактивны
2DebitProcessingExceptionОшибка при выполнении дебетовой операции в процессинговом центре.
3TransactionProcessingExceptionОшибка выполнения транзакции.
4TransactionCancelledByTimeoutТранзакция отменена из-за таймаута.
5MoneyRefundВозврат денег.
10UnknownExceptionНеизвестная ошибка.

Состояния чека(Receipt State)

КодКлючОписание
0CreatedЧек создан. Ожидание подтверждения оплаты.
4SuccessfulЧек оплачен.
21CancelledЧек в очереди на отмену.
50FailedЧек отменен.

Статусы пользователей(Customer Status)

КодКлючОписание
0TopUpAvailableПополнение возможно/доступно.
1TopUpUnavailableПополнение невозможно/недоступно.
2IncorrectAccountFormatНеправильный формат аккаунта.
3InternalErrorВнутренняя ошибка системы.
4CustomerNotFoundПользователь или несколько пользователей не были найдены.
5TechnicalWorksВедутся профилактические работы.
7RestrcitedByMerchantОграничено оператором, в следствии чего невозможно выполнить пополнение (Прим. из-за задолженности или специальных условий тарифа).
8UknownErrorНеизвестная ошибка или проблема требующая дальнейшего изучения .

Список получателей (Customer)

ИмяТипОписание
idStringИдентификатор кассы.
amountAmountСумма платежа в тийинах.

Дополнительные детали объекта details

ПараметрТипОписание
receipt_typeIntegerТип фискального чека: Продажа/Возврат = 0, Аванс = 1, Кредит = 2, Информационный = 3
itemsListСписок товаров и услуг (items)

Фискальные данные OFDResponseDetails

"ofd": [
{
"id": null,
"code": null,
"message": null,
"terminalId": null,
"receiptId": null,
"time": null,
"fiscalSign": null,
"qrCodeUrl": null,
"tin": null,
"spic": "10401999001000000",
"vatRate": 0,
"label": null,
"packageCode": null,
"type": "",
"merchantInfo": {
"tin": "testBeepul",
"pinfl": "testBeepul"
},
"items": [
{
"title": "string",
"unit_price": 10000,
"count": 2,
"spic": "00702001001000001",
"pinfl": "",
"tin": "",
"package_code": "123456",
"units": 241092,
"vat_percent": 15,
"discount": 10000
}
]
}
]
ПараметрТипОписание
idStringИдентификатор детали ответа
codeByteКод ответа HTTP
messageStringСообщение, связанное с ответом
terminalIdStringИдентификатор терминала
receiptIdLongИдентификатор чека
timeStringВремя генерации ответа
fiscalSignStringФискальный признак, связанный с чеком
qrCodeURLStringURL QR-кода, связанного с чеком
tinStringИНН
spicStringКод ИКПУ
vatRateDecimalСтавка НДС
labelStringМетка или дополнительное описание
packageCodeStringКод упаковки
typeStringТип операции или документа
merchantInfoObjectИнформация о продавце или исполнителе услуг
itemsObjectСписок товаров и услуг

Дополнительные параметры внутри merchantInfo

ПараметрТипОписание
tinstringИНН продавца или исполнителя услуг
pinflstringПИНФЛ продавца или исполнителя услуг

Дополнительные параметры внутри items

ПараметрТипОписание
titleStringНаименование товара или услуги
unit_priceDecimalЦена за единицу товара или услуги
countDecimalКоличество товара или услуги
spicStringКод ИКПУ для товара или услуги
pinflStringПИНФЛ, связанный с товаром или услугой
tinStringИНН, связанный с товаром или услугой
package_codeStringКод упаковки для товара
unitsIntegerЕдиницы измерения или код единицы измерения
vat_percentDecimalПроцент НДС для товара или услуги
discountDecimalСумма скидки для товара или услуги