tinkoff_acquiring library
Является базовым модулем для работы с Tinkoff Acquiring API. Модуль реализует протокол взаимодействия с сервером и позволяет не осуществлять прямых обращений в API.
Основной класс модуля: TinkoffAcquiring - предоставляет интерфейс для взаимодействия с Tinkoff Acquiring API.
Для работы необходимы ключи и пароль продавца.
Classes
- AccountQrToken
- AcquiringRequest
- Базовый класс создания запроса Acquiring API
- AcquiringResponse
- Базовый класс ответа Acquiring API
- AddAccountQrRequest
- Метод инициирует привязку счета покупателя к магазину в СБП и возвращает информацию о нём.
- AddAccountQrResponse
- Ответ от сервера на инициацию привязки счета покупателя к магазину в СБП и возвращает информацию о нём.
- AddCardRequest
- Метод инициирует привязку карты к покупателю.
- AddCardResponse
- Ответ от сервера на привязку карты к покупателю
- AddCustomerRequest
- Метод регистрирует покупателя и его данные в системе продавца.
- AddCustomerResponse
- Ответ от сервера на регистрацию покупателя
- AddUserProp
- Данные поставщика платежного агента
- AgentData
- Данные агента
- ApplePayData
- Тип оплаты с помощью Apple Pay
- AttachCardRequest
- Метод завершает привязку карты к покупателю. Метод дложен вызывается после метода AddCard.
- AttachCardResponse
- Ответ от сервера по завершению привязки карты к покупателю
- AttachedCardData
- Данные привязанной карты
- BaseRequest
- Базовый класс запроса
- BaseResponse
- Базовый класс ответа
- CancelRequest
- Метод отменяет платеж
- CancelResponse
- Ответ от сервера на отмену платежа
- CardData
- Данные карты
- CardInfo
- Данные карты
- CardSource
- Интерфейс данных карты
- ChargeQrRequest
- Проведение платежа по привязанному счету по QR через СБП.
- ChargeQrResponse
- Ответ от сервера на проведение платежа по привязанному счету QR
- ChargeRequest
- Метод осуществляет автоплатеж.
- ChargeResponse
- Ответ от сервера на автоплатеж
- Check3DSVersionRequest
- Метод проверяет поддерживаемую версию 3DS протокола по карточным данным из входящих параметров
- Check3DSVersionResponse
- Ответ от сервера по проверки 3DS протокола
- CheckOrderRequest
- Метод возвращает текущий статус платежа.
- CheckOrderResponse
- Ответ от сервера на получение статуса платежа
- ClientInfo
- Информация по покупателю
- ConfirmRequest
- Метод подтверждает платеж и списывает ранее заблокированные средства. Используется при двухстадийной оплате. При одностадийной оплате вызывается автоматически.
- ConfirmResponse
- Ответ от сервера на подтверждения платежа
- FinishAuthorizeRequest
- Метод подтверждает платеж передачей реквизитов, а также списывает средства с карты покупателя при одностадийной оплате и блокирует указанную сумму при двухстадийной.
- FinishAuthorizeResponse
- Ответ от сервера на подтверждение платежа
- GetAccountQrListRequest
- Возвращает список привязанных счетов покупателя по магазину
- GetAccountQrListResponse
- Ответ от сервера на список привязанных счетов покупателя по магазину
- GetAddAccountQrStateRequest
- Метод возвращает статус привязки счета Покупателя по магазину в СБП
- GetAddAccountQrStateResponse
- Ответ от сервера на статус привязки счета Покупателя по магазину в СБП
- GetAddCardStateRequest
- Возвращает статус привязки карты.
- GetAddCardStateResponse
- Ответ от сервера на статус привязки карты.
- GetCardListRequest
- Метод возвращает список привязанных карт у покупателя
- GetCardListResponse
- Ответ от сервера на список привязанных карт у покупателя
- GetCustomerRequest
- Метод по получению данных покупателя из системы продавца.
- GetCustomerResponse
- Ответ от сервера на получению данных покупателя
- GetQrRequest
-
Метод регистрирует QR и возвращает информацию о нем. Должен быть вызван после метода
Init - GetQrResponse
- Ответ от сервера на регистрацию QR
- GetStateRequest
- Метод возвращает текущий статус платежа.
- GetStateResponse
- Ответ от сервера на получение статуса платежа
- GetStaticQrRequest
- Метод регистрирует статический QR и возвращает информацию о нем.
- GetStaticQrResponse
- Ответ от сервера на регистрацию статического QR
- GooglePayData
- Тип оплаты с помощью Google Pay
- InitRequest
- Метод создает платеж: продавец получает ссылку на платежную форму и должен перенаправить по ней покупателя
- InitResponse
- Ответ от сервера на создание платежа
- Items
- Массив позиций чека с информацией о товарах.
- MarkCode
- Код маркировки в машиночитаемой форме, представленный в виде одного из видов кодов, формируемых в соответствии с требованиями, предусмотренными правилами, для нанесения на потребительскую упаковку, или на товары, или на товарный ярлык.
- MarkQuantity
- Реквизит «дробное количество маркированного товара».
- Member
- Данные участника
- OperatingCheckProps
- Операционный реквизит чека (тег 1270), только для ФФД 1.2
- OrderPayments
- Детали заказа
- Payments
- Объект с информацией о видах оплаты заказа
- PaymentSource
- Источник оплаты
- ProxyRequest
- Модель Proxy запроса, позволяет задать свой путь и заголовок при обращении к Proxy API.
- QrMembersListRequest
- Метод возвращает cписок участников куда может быть осуществлен возврат платежа, совершенного по QR.
- QrMembersListResponse
- Ответ от сервера на получение cписока участников куда может быть осуществлен возврат платежа, совершенного по QR.
- Receipt
- Данные чека
- RemoveCardRequest
- Метод удаляет привязанную карту у покупателя
- RemoveCardResponse
- Ответ от сервера по удалению привязанной карты у покупателя
- RemoveCustomerRequest
- Метод удаляет данные зарегистрированного покупателя.
- RemoveCustomerResponse
- Ответ от сервера на удаление данных покупателя
- ResendRequest
- Метод отправляет все неотправленные уведомления.
- ResendResponse
- Ответ от сервера на отправку неотправленных уведомлений
- SbpPayTestRequest
- Тестирование платежной сессии с предопределенным статусом по СБП.
- SbpPayTestResponse
- Ответ от сервера на тестированию платежной сессии с предопределенным статусом по СБП.
- SectoralCheckProps
- Данные поставщика платежного агента
- SectoralItemProps
- Отраслевой реквизит предмета расчета. Необходимо указывать только для товаров подлежащих обязательной маркировке средством идентификации и включение данного реквизита предусмотрено НПА отраслевого регулирования для соответствующей товарной группы.
- SendClosingReceiptRequest
- Метод позволяет отправить закрывающий чек в кассу.
- SendClosingReceiptResponse
- Ответ от сервера на закрывающий чек в кассу
- Shops
- Данными Маркетплейса
- Submit3DSAuthorizationResponse
- Ответ от сервера на прохождение 3-D Secure
- SupplierInfo
- Данные поставщика платежного агента
- TinkoffAcquiring
- Класс позволяет осуществлять взаимодействие с Tinkoff Acquiring API.
- TinkoffAcquiringConfig
- Класс позволяет конфигурировать SDK.
- TinkoffAcquiringConfigCredential
-
Создает экземпляр класса для конфигурирования SDK, через
terminalKeyиpassword. - TinkoffAcquiringConfigProxy
-
Создает экземпляр класса для конфигурирования SDK, через
proxy - TinkoffAcquiringConfigToken
-
Создает экземпляр класса для конфигурирования SDK, через
terminalKeyпри работе сsignToken
Enums
- AgentSign
- Признак агента.
- CardStatus
- Статус карты
- CardType
- Тип карты
- CheckType
- Тип проверки карты
- DataType
- Тип возвращаемых данных
- Language
- Список языков платежной формы
- MarkCodeType
- Тип штрих кода
- PaymentMethod
- Признак способа расчета
- PaymentObject
- Признак предмета расчета
- PayType
- Список типов оплаты
- Route
- Способ платежа.
- Source
- Источник платежа.
- Status
- Статус в ответе на запрос методов
- Tax
- Ставка НДС
- Taxation
- Система налогообложения
Typedefs
- ProxyMapping = ProxyRequest? Function(AcquiringRequest request, bool isDebugMode)
- Функция позволяющая модифицировать запрос к proxy api. Позволяет изменять путь и загаловок запроса.