Skip to main content

TransfersController


TransfersController

Transfers controller

  • Full name: \kennethormandy\marketplace\console\controllers\TransfersController
  • Parent class: Controller

Properties

defaultAction

public $defaultAction

orderId

public int $orderId

Methods

options

public options(mixed $actionID): array

Parameters:

ParameterTypeDescription
$actionIDmixed

actionIndex

marketplace/transfers command

public actionIndex(): int

actionCreate

Create transfers for an existing order.

public actionCreate(): int

Example:

php craft marketplace/transfers/create --order-id 999

If, for some reason, you need to run payment splitting on an existing order—ex. if you had an error unrelated to Marketplace that prevented Marketplace from running after an order was completed—you can try and run it again using this console command.

This runs the same codepath as during checkout, with the following safeguards:

  • Marketplace will not create more transfers if there is already a transfer in place on Stripe
  • Stripe will never let you create transfers that total more than the original payment total (ex. if the order total is $20, Stripe would not let you make three $10 transfers)


Automatically generated on 2024-11-13