Версия: 6.x
burger close
Интерфейс InterfaceRecurringPayments
Граф наследования:InterfaceRecurringPayments:
YandexKassaApi

Подробное описание

Интерфейс рекуррентных платежей Используется вместе с трейтом Shop

Открытые члены

 isRecurringPaymentsActive ()
 
 getRecurringPaymentsType ()
 
 recurringPayOrder (Order $order, SavedPaymentMethod $saved_payment_method)
 
 recurringPayBalanceFounds (User $user, float $cost, SavedPaymentMethod $saved_payment_method)
 
 refundBindingTransaction (Transaction $transaction)
 
 getSavedPaymentMethods (User $user)
 
 deleteSavedPaymentMethod (SavedPaymentMethod $saved_payment_method)
 
 getAdminRecurringPaymentsHtml (Order $order)
 
 executeInterfaceRecurringPaymentsAction (Order $order, string $action)
 

Поля данных

const RECURRING_TYPE_NONE = 'none'
 
const RECURRING_TYPE_SAVE_METHOD = 'save_method'
 
const RECURRING_TYPE_ONLY_SAVE_METHOD = 'only_save_method'
 
const TRANSACTION_EXTRA_KEY_SAVED_METHOD = 'saved_payment_method'
 
const RECURRING_ACTION_SAVED_METHODS_FORM = 'saved_methods_form'
 
const RECURRING_ACTION_SELECT_SAVED_METHOD = 'select_saved_method'
 
const RECURRING_ACTION_PAY_WITH_SAVED_METHOD = 'pay_with_saved_method'
 

Методы

deleteSavedPaymentMethod ( SavedPaymentMethod  $saved_payment_method)

Удаляет сохранённый способ платежа

Аргументы
SavedPaymentMethod$saved_payment_method- Сохранённый способ платежа
Возвращает
void
Исключения
ShopException

Замещается в YandexKassaApi.

executeInterfaceRecurringPaymentsAction ( Order  $order,
string  $action 
)

Исполняет действие из административной панели "рекуррентных платежей" с указанным заказом. На текущий момент действий бывает несколько:

  • Показать форму выбора сохраненных способов платежей
  • Выбрать другой способ платежа
  • Оплатить выбранным способом платежа
Аргументы
Order$order- заказ
string$action- действие
Возвращает
array
getAdminRecurringPaymentsHtml ( Order  $order)

Возвращает дополнительный HTML для админ части в заказе

Аргументы
Order$order- заказ
Возвращает
string
getRecurringPaymentsType ( )

Возвращает режим работы "рекуррентных платежей" (возможные значения описаны в интерфейсе)

Возвращает
string
getSavedPaymentMethods ( User  $user)

Возвращает список сохранённых способов оплаты для указанного пользователя

Аргументы
User$user- объект пользователя
Возвращает
SavedPaymentMethod[]
isRecurringPaymentsActive ( )

Возвращает включены ли рекуррентные платежи

Возвращает
bool
recurringPayBalanceFounds ( User  $user,
float  $cost,
SavedPaymentMethod  $saved_payment_method 
)

Производит "рекуррентное" пополнение лицевого счёта Автоматически списывает с $saved_payment_method средства и увеличивает баланс лицевого счета $user на сумму $cost

Аргументы
User$user- пользователь
float$cost- сумма пополнения
SavedPaymentMethod$saved_payment_method- сохранённый способ платежа
Возвращает
void

Замещается в YandexKassaApi.

recurringPayOrder ( Order  $order,
SavedPaymentMethod  $saved_payment_method 
)

Производит "рекуррентную" оплату заказа. Автоматически списывает с $saved_payment_method средства за заказ $order

Аргументы
Order$order- заказ
SavedPaymentMethod$saved_payment_method- сохранённый способ платежа
Возвращает
void

Замещается в YandexKassaApi.

refundBindingTransaction ( Transaction  $transaction)

Производит возврат транзакции, привязывающей новый способ платежа Создает транзакцию RS на списание суммы, указанной в $transaction и выполняет запрос на полный возврат средств к платежной системе.

Аргументы
Transaction$transaction- транзакция
Возвращает
void

Замещается в YandexKassaApi.

Поля

const RECURRING_ACTION_PAY_WITH_SAVED_METHOD = 'pay_with_saved_method'
const RECURRING_ACTION_SAVED_METHODS_FORM = 'saved_methods_form'
const RECURRING_ACTION_SELECT_SAVED_METHOD = 'select_saved_method'
const RECURRING_TYPE_NONE = 'none'
const RECURRING_TYPE_ONLY_SAVE_METHOD = 'only_save_method'
const RECURRING_TYPE_SAVE_METHOD = 'save_method'
const TRANSACTION_EXTRA_KEY_SAVED_METHOD = 'saved_payment_method'