ru.tinkoff.acquiring.sdk

Class AcquiringSdk

java.lang.Object

ru.tinkoff.acquiring.sdk.Journal

ru.tinkoff.acquiring.sdk.AcquiringSdk

public class AcquiringSdk
extends Journal

Класс позволяет конфигурировать SDK и осуществлять взаимодействие с Тинькофф Эквайринг API. Методы, осуществляющие обращение к API, возвращают результат в случае успешного выполнения запроса или бросают исключение (ошибку для iOS) AcquringSdkException (AcquiringSdkError).

Constructor Summary

Constructors

Constructor and Description
AcquiringSdk(java.lang.String terminalKey, java.lang.String password, KeyCreator keyCreator)
AcquiringSdk(java.lang.String terminalKey, java.lang.String password, java.security.PublicKey publicKey) Создает новый экземпляр SDK
AcquiringSdk(java.lang.String terminalKey, java.lang.String password, java.lang.String publicKey) Создает новый экземпляр SDK

Method Summary

Modifier and Type	Method and Description
PaymentInfo	charge(long paymentId, java.lang.String rebillId) Осуществляет рекуррентный (повторный) платеж — безакцептное списание денежных средств со счета банковской карты Покупателя.
ThreeDsData	finishAuthorize(long paymentId, CardData cardData, java.lang.String infoEmail) Подтверждает инициированный платеж передачей карточных данных
Card[]	getCardList(java.lang.String customerKey) Возвращает список привязанных карт
java.lang.String	getPassword()
java.security.PublicKey	getPublicKey()
PaymentStatus	getState(long paymentId) Возвращает статус платежа
java.lang.String	getTerminalKey()
java.lang.String	getUrl(java.lang.String apiMethod)
java.lang.Long	init(InitRequestBuilder builder) Инициирует платежную сессию
boolean	removeCard(java.lang.String customerKey, java.lang.String cardId) Удаляет привязанную карту

Methods inherited from class ru.tinkoff.acquiring.sdk.Journal

isDebug, log, log, setDebug, setLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AcquiringSdk

public AcquiringSdk(java.lang.String terminalKey,
                    java.lang.String password,
                    java.security.PublicKey publicKey)

Создает новый экземпляр SDK

Parameters:

terminalKey - ключ терминала. Выдается после подключения к Тинькофф Эквайринг

password - пароль от терминала. Выдается вместе с terminalKey

publicKey - экземпляр PublicKey созданный из публичного ключа, выдаваемого вместе с terminalKey

AcquiringSdk

public AcquiringSdk(java.lang.String terminalKey,
                    java.lang.String password,
                    java.lang.String publicKey)

Создает новый экземпляр SDK

Parameters:

terminalKey - ключ терминала. Выдается после подключения к Тинькофф Эквайринг

password - пароль от терминала. Выдается вместе с terminalKey

publicKey - публичный ключ. Выдается вместе с terminalKey

AcquiringSdk

public AcquiringSdk(java.lang.String terminalKey,
                    java.lang.String password,
                    KeyCreator keyCreator)

Method Detail

getTerminalKey

public java.lang.String getTerminalKey()

getPassword

public java.lang.String getPassword()

getPublicKey

public java.security.PublicKey getPublicKey()

init

public java.lang.Long init(InitRequestBuilder builder)

Инициирует платежную сессию

Parameters:

builder - Билдер связанный с запросом Init

Returns:

уникальный идентификатор транзакции в системе Банка

finishAuthorize

public ThreeDsData finishAuthorize(long paymentId,
                                   CardData cardData,
                                   java.lang.String infoEmail)

Подтверждает инициированный платеж передачей карточных данных

Parameters:

paymentId - уникальный идентификатор транзакции в системе Банка

cardData - данные карты

infoEmail - email, на который будет отправлена квитанция об оплате

Returns:

Объект ThreeDsData если терминал требует прохождения 3DS, иначе null

getCardList

public Card[] getCardList(java.lang.String customerKey)

Возвращает список привязанных карт

Parameters:

customerKey - идентификатор покупателя в системе Продавца

Returns:

список сохраненных карт

charge

public PaymentInfo charge(long paymentId,
                          java.lang.String rebillId)

Осуществляет рекуррентный (повторный) платеж — безакцептное списание денежных средств со счета банковской карты Покупателя. Для возможности его использования Покупатель должен совершить хотя бы один платеж в пользу Продавца, который должен быть указан как рекуррентный (см. параметр recurrent в методе Init), фактически являющийся первичным.

Другими словами, для использования рекуррентных платежей необходима следующая последовательность действий:

1. Совершить родительский платеж путем вызова Init с указанием дополнительного параметра Recurrent=Y.
2. Получить RebillId, предварительно вызвав метод GetCardList
3. Спустя некоторое время для совершения рекуррентного платежа необходимо вызвать метод Init со стандартным набором параметров (параметр Recurrent здесь не нужен).
4. Получить в ответ на Init параметр PaymentId.
5. Вызвать метод Charge с параметром RebillId полученным в п.2 и параметром PaymentId полученным в п.4.

Parameters:

paymentId -

rebillId -

Returns:

getState

public PaymentStatus getState(long paymentId)

Возвращает статус платежа

Parameters:

paymentId - уникальный идентификатор транзакции в системе Банка

Returns:

статус платежа

removeCard

public boolean removeCard(java.lang.String customerKey,
                          java.lang.String cardId)

Удаляет привязанную карту

Parameters:

customerKey - идентификатор покупателя в системе Продавца

cardId - идентификатор карты в системе Банка

Returns:

признак, удалена ли карта

getUrl

public java.lang.String getUrl(java.lang.String apiMethod)

Returns:

Возвращает URL адрес API, в зависимости от названия метода