BxPaymentProviderStripeV3 Class Reference

Inheritance diagram for BxPaymentProviderStripeV3:

Public Member Functions
	__construct ($aConfig)
	actionGetSessionRecurring ()
	authorizeCheckout ($iPendingId, $aCartInfo, $sRedirect='')
	captureAuthorizedCheckout ($sOrderAuth, $mixedPending, $aInfo)
	initializeCheckout ($iPendingId, $aCartInfo, $sRedirect='')
	finalizeCheckout (&$aData)
	getButtonSingle ($iClientId, $iVendorId, $aParams=array())
	overwriteCheckoutParamsSingle ($aParams, &$oGrid)
	createSessionAuthorize ($sType, $iClientId, $iSellerId, $sItems, $aSessionParams=[])
	createSessionPaymentEmbedded ($sType, $iClientId, $iSellerId, $sItems, $aSessionParams=[])
	createTax ($sName, $fPercentage, $bInclusive=false)
	retrieveTax ($sId)
	getVerificationCodeSession ($iVendorId, $iCustomerId, $fAmount, $sCurrency)
	checkVerificationCodeSession ($iVendorId, $iCustomerId, $aResult)
Public Member Functions inherited from BxPaymentProviderStripeBasic
	initOptions ($aOptions)
	addJsCss ()
	getJsObject ($aParams=array())
	notify ()
	getButtonSingleJs ($iClientId, $iVendorId, $aParams=array())
	getButtonRecurring ($iClientId, $iVendorId, $aParams=array())
	getButtonRecurringJs ($iClientId, $iVendorId, $aParams=array())
	getMenuItemsActionsRecurring ($iClientId, $iVendorId, $aParams=array())
	getDetailsRecurring ($iPendingId, $sCustomerId, $sSubscriptionId)
	changeDetailsRecurring ($iPendingId, $sCustomerId, $sSubscriptionId)
	getBillingRecurring ($iPendingId, $sCustomerId, $sSubscriptionId)
	changeBillingRecurring ($iPendingId, $sCustomerId, $sSubscriptionId)
	cancelRecurring ($iPendingId, $sCustomerId, $sSubscriptionId)
	getSubscription ($iPendingId, $sCustomerId, $sSubscriptionId)
Public Member Functions inherited from BxBaseModPaymentProvider
	initOptionsByVendor ($iVendorId)
	isActive ()
	isHidden ()
	getOption ($sName)
	setOption ($sName, $mixedValue, $bSave=false)
	getReturnUrl ($aParams=array())
	getReturnDataUrl ($iVendorId, $aParams=array())
	getNotifyUrl ($iVendorId, $aParams=array())
	needRedirect ()
	getJsObject ()
	finalizedCheckout ()
	isSubscriptionStatus ($sStatus, $aSubscription, $sStatusKey='status')
Public Member Functions inherited from iBxBaseModPaymentProvider
	initializeCheckout ($iPendingId, $aCartInfo)
	finalizedCheckout ()

Protected Member Functions
	_getStripe ()
	_retrieveCustomer ($sType, $sId)
	_createSession ($sType, $aParams, &$aClient, &$aCartInfo)
	_getSession ($sType, $sId)
	_retrieveSession ($sId)
	_retrieveSetupIntent ($sId)
	_createPaymentIntent ($sSetupIntentId, $fAmount, $sCurrency, $bConfirm=true)
	_retrievePaymentIntent ($sId)
	_retrieveSubscription ($sCustomerId, $sSubscriptionId)
	_createToken ($aCard)
	_createCard ($sType, $sCustomerId, $sToken)
	_retrieveCard ($sCustomerId, $sCardId='')
	_retrievePaymentMethod ($sPaymentMethodId)
	_getButton ($sType, $iClientId, $iVendorId, $aParams=array())
	_getButtonJs ($sType, $iClientId, $iVendorId, $aParams=array())
	_getVerificationCodeSession ($iVendorId, $iCustomerId, $fAmount, $sCurrency)
	_checkVerificationCodeSession ($iVendorId, $iCustomerId, $aResult)
	_processException ($sMessage, &$oException)
Protected Member Functions inherited from BxPaymentProviderStripeBasic
	_getPublicKey ()
	_getSecretKey ()
	_retrieveCharge ($sId)
	_cancelSubscription ($sCustomerId, $sSubscriptionId)
	_retrieveProduct ($sId)
	_listPlans ($iLimit=100)
	_retrieveEvent ($sId)
	_processEvent ()
	_processEventInvoicePaymentSucceeded (&$aEvent)
	_processEventChargeRefunded (&$aEvent)
	_processEventCustomerSubscriptionDeleted (&$aEvent)
	_getData (&$aEvent, $bRetrieve=true)
	_getDataInvoicePaymentSucceeded (&$aEvent, $bRetrieve=true)
	_getDataChangeDetailsRecurring ($iPendingId)
Protected Member Functions inherited from BxBaseModPaymentProvider
	getOptionsByPending ($iPendingId)
	getOptionsByVendor ($iVendorId)
	log ($mixedContents, $sTitle='')

Protected Attributes
	$_oStripe
	$_iAmountPrecision
Protected Attributes inherited from BxPaymentProviderStripeBasic
	$_sFormDetails
	$_sFormDisplayDetailsEdit
	$_sFormCard
	$_sFormDisplayCardAdd
	$_iMode
	$_bCheckAmount
	$_bProrate
	$_oCustomer
Protected Attributes inherited from BxBaseModPaymentProvider
	$MODULE
	$_oModule
	$_sLangsPrefix
	$_iId
	$_sName
	$_sCaption
	$_sPrefix
	$_iVendor
	$_aOptions
	$_bUseSsl
	$_bRedirectOnResult
	$_aSbsStatuses
	$_aIncludeJs
	$_aIncludeCss

Constructor & Destructor Documentation

__construct()

BxPaymentProviderStripeV3::__construct

(

$aConfig

)

Reimplemented from BxPaymentProviderStripeBasic.

Member Function Documentation

_createPaymentIntent()

BxPaymentProviderStripeV3::_createPaymentIntent ( $sSetupIntentId, $fAmount, $sCurrency, $bConfirm = true )

protected

Hooks:

'bx_payment', 'stripe_v3_create_payment_intent' - hook to override PaymentIntent data redurned by payment provider

• $unit_name - equals bx_payment
• $action - equals stripe_v3_create_payment_intent
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • setup_intent_id - [string] by ref, unique SetupIntent id, can be overridden in hook processing
  • payment_intent_object - [object] by ref, an instance of PaymentIntent, redurned by payment provider, can be overridden in hook processing

    HOOKS

    'bx_payment', 'stripe_v3_create_payment_intent' - hook to override PaymentIntent data redurned by payment provider

_createSession()

BxPaymentProviderStripeV3::_createSession ( $sType, $aParams, & $aClient, & $aCartInfo )

protected

Hooks:

'bx_payment', 'stripe_v3_create_session' - hook to override session data redurned by payment provider

• $unit_name - equals bx_payment
• $action - equals stripe_v3_create_session
• $object_id - pending transaction id
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • session_object - [object] by ref, an instance of session, redurned by payment provider, can be overridden in hook processing
  • session_params - [array] by ref, array with session parameters, can be overridden in hook processing

    HOOKS

    'bx_payment', 'stripe_v3_create_session' - hook to override session data redurned by payment provider

_getButton()

BxPaymentProviderStripeV3::_getButton ( $sType, $iClientId, $iVendorId, $aParams = array() )

protected

Reimplemented from BxPaymentProviderStripeBasic.

_getButtonJs()

BxPaymentProviderStripeV3::_getButtonJs ( $sType, $iClientId, $iVendorId, $aParams = array() )

protected

Hooks:

'bx_payment', 'stripe_v3_get_button' - hook to override checkout/subscibe button

• $unit_name - equals bx_payment
• $action - equals stripe_v3_get_button
• $object_id - not used
• $sender_id - client (buyer) profile id
• $extra_params - array of additional params with the following array keys:
  • type - [string] by ref, payment type ('single' or 'recurring'), can be overridden in hook processing
  • public_key - [string] by ref, public key from Stripe account, can be overridden in hook processing

    HOOKS

    'bx_payment', 'stripe_v3_get_button' - hook to override checkout/subscibe button

_processException()

BxPaymentProviderStripeV3::_processException ( $sMessage, & $oException )

protected

Reimplemented from BxPaymentProviderStripeBasic.

_retrieveCustomer()

BxPaymentProviderStripeV3::_retrieveCustomer ( $sType, $sId )

protected

Hooks:

'bx_payment', 'stripe_v3_retrieve_customer' - hook to override customer data retrieved from payment provider

It's equivalent to 'bx_payment', 'stripe_retrieve_customer' - hook to override customer data retrieved from payment provider

HOOKS

'bx_payment', 'stripe_v3_retrieve_customer' - hook to override customer data retrieved from payment provider

Reimplemented from BxPaymentProviderStripeBasic.

_retrievePaymentIntent()

BxPaymentProviderStripeV3::_retrievePaymentIntent ( $sId )

protected

Hooks:

'bx_payment', 'stripe_v3_retrieve_payment_intent' - hook to override PaymentIntent data retrieved from payment provider

• $unit_name - equals bx_payment
• $action - equals stripe_v3_retrieve_payment_intent
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • payment_intent_id - [string] by ref, unique PaymentIntent id, can be overridden in hook processing
  • payment_intent_object - [object] by ref, an instance of PaymentIntent, redurned by payment provider, can be overridden in hook processing

    HOOKS

    'bx_payment', 'stripe_v3_retrieve_payment_intent' - hook to override PaymentIntent data retrieved from payment provider

_retrievePaymentMethod()

BxPaymentProviderStripeV3::_retrievePaymentMethod ( $sPaymentMethodId )

protected

Reimplemented from BxPaymentProviderStripeBasic.

_retrieveSession()

BxPaymentProviderStripeV3::_retrieveSession ( $sId )

protected

Hooks:

'bx_payment', 'stripe_v3_retrieve_session' - hook to override session data retrieved from payment provider

• $unit_name - equals bx_payment
• $action - equals stripe_v3_retrieve_session
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • session_id - [string] by ref, unique session id, can be overridden in hook processing
  • session_object - [object] by ref, an instance of session, redurned by payment provider, can be overridden in hook processing

    HOOKS

    'bx_payment', 'stripe_v3_retrieve_session' - hook to override session data retrieved from payment provider

_retrieveSetupIntent()

BxPaymentProviderStripeV3::_retrieveSetupIntent ( $sId )

protected

Hooks:

'bx_payment', 'stripe_v3_retrieve_setup_intent' - hook to override SetupIntent data retrieved from payment provider

• $unit_name - equals bx_payment
• $action - equals stripe_v3_retrieve_setup_intent
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • setup_intent_id - [string] by ref, unique SetupIntent id, can be overridden in hook processing
  • setup_intent_object - [object] by ref, an instance of SetupIntent, redurned by payment provider, can be overridden in hook processing

    HOOKS

    'bx_payment', 'stripe_v3_retrieve_setup_intent' - hook to override SetupIntent data retrieved from payment provider

_retrieveSubscription()

BxPaymentProviderStripeV3::_retrieveSubscription ( $sCustomerId, $sSubscriptionId )

protected

Hooks:

'bx_payment', 'stripe_v3_retrieve_subscription' - hook to override subscription data retrieved from payment provider

• $unit_name - equals bx_payment
• $action - equals stripe_v3_retrieve_subscription
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • subscription_id - [string] by ref, unique subscription id, can be overridden in hook processing
  • subscription_object - [object] by ref, an instance of subscription, redurned by payment provider, can be overridden in hook processing

    HOOKS

    'bx_payment', 'stripe_v3_retrieve_subscription' - hook to override subscription data retrieved from payment provider

Reimplemented from BxPaymentProviderStripeBasic.

checkVerificationCodeSession()

BxPaymentProviderStripeV3::checkVerificationCodeSession	(		$iVendorId,
			$iCustomerId,
			$aResult )

Hooks:

'bx_payment', 'stripe_v3_verify_session' - hook to override checking of session verification code

• $unit_name - equals bx_payment
• $action - equals stripe_v3_verify_session
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • provider - [object] an instance of provider,

    See also

    BxBaseModPaymentProvider

  • vendor_id - [int] vendor (seller) profile id
  • customer_id - [int] customer (buyer) profile id
  • result - [array] results array received from payment provider
  • override_result - [boolean] by ref, is verification passed or not, can be overridden in hook processing

    HOOKS

    'bx_payment', 'stripe_v3_verify_session' - hook to override checking of session verification code

createSessionAuthorize()

BxPaymentProviderStripeV3::createSessionAuthorize	(		$sType,
			$iClientId,
			$iSellerId,
			$sItems,
			$aSessionParams = [] )

Note. Isn't used for now in default version.

createTax()

BxPaymentProviderStripeV3::createTax	(		$sName,
			$fPercentage,
			$bInclusive = false )

Hooks:

'bx_payment', 'stripe_v3_create_tax' - hook to override tax data redurned by payment provider

• $unit_name - equals bx_payment
• $action - equals stripe_v3_create_tax
• $object_id - pending transaction id
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • tax_object - [object] by ref, an instance of tax, redurned by payment provider, can be overridden in hook processing
  • tax_params - [array] by ref, array with tax parameters, can be overridden in hook processing

    HOOKS

    'bx_payment', 'stripe_v3_create_tax' - hook to override tax data redurned by payment provider

finalizeCheckout()

BxPaymentProviderStripeV3::finalizeCheckout

(

&

$aData

)

Implements iBxBaseModPaymentProvider.

getButtonSingle()

BxPaymentProviderStripeV3::getButtonSingle	(		$iClientId,
			$iVendorId,
			$aParams = array() )

Reimplemented from BxPaymentProviderStripeBasic.

getVerificationCodeSession()

BxPaymentProviderStripeV3::getVerificationCodeSession	(		$iVendorId,
			$iCustomerId,
			$fAmount,
			$sCurrency )

Hooks:

'bx_payment', 'stripe_v3_get_code_session' - hook to override session verification code

• $unit_name - equals bx_payment
• $action - equals stripe_v3_get_code_session
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • provider - [object] an instance of provider,

    See also

    BxBaseModPaymentProvider

  • vendor_id - [int] vendor (seller) profile id
  • customer_id - [int] customer (buyer) profile id
  • amount - [float] session amount
  • currency - [string] session currency code
  • override_result - [string] by ref, verification code, can be overridden in hook processing

    HOOKS

    'bx_payment', 'stripe_v3_get_code_session' - hook to override session verification code

retrieveTax()

BxPaymentProviderStripeV3::retrieveTax

(

$sId

)

Hooks:

'bx_payment', 'stripe_v3_retrieve_tax' - hook to override tax data retrieved from payment provider

• $unit_name - equals bx_payment
• $action - equals stripe_v3_retrieve_tax
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • tax_id - [string] by ref, unique tax id, can be overridden in hook processing
  • tax_object - [object] by ref, an instance of tax, redurned by payment provider, can be overridden in hook processing

    HOOKS

    'bx_payment', 'stripe_v3_retrieve_tax' - hook to override tax data retrieved from payment provider

---

The documentation for this class was generated from the following file:

• modules/boonex/payment/classes/BxPaymentProviderStripeV3.php