Skip to main content

Payees


Payees

The Payee service is distinct from the Accounts service, because the Accounts service does not necessarily have anything to do with ecommerce yet. All Payees are Accounts, but not all accounts are Payees (incomplete accounts, disabled accounts, etc.)

  • Full name: \kennethormandy\marketplace\services\Payees
  • Parent class: Component

Constants

ConstantVisibilityTypeValue
EVENT_BEFORE_DETERMINE_PAYEEpublic'beforeDeterminePayee'
EVENT_AFTER_DETERMINE_PAYEEpublic'afterDeterminePayee'

Methods

init

public init(): void

getAccountId

Determine and return the payee’s account ID, based on a Commerce LineItem.

public getAccountId(\craft\commerce\models\LineItem $lineItem): null|string

Parameters:

ParameterTypeDescription
$lineItem\craft\commerce\models\LineItem

Return Value:

The gateway account ID. If this is null, there is effectively no payee, so this line item will be treated like a typical Commerce order and not use Marketplace.



Automatically generated on 2024-11-04