SplitDriverInterface

Source: view src/Contracts/SplitDriverInterface.php

Generated from the public PHP contract and its PHPDoc. Driver support varies; check instanceof or GatewayCapabilities before calling optional gateway capabilities.

createSplit

Create a transaction split for dividing payments among multiple subaccounts. Expected $data keys: name (string) required — split name type (string) required — 'percentage' or 'flat' currency (string) required — supported currency code subaccounts (array) required — [{subaccount: 'ACCT_xxx', share: 50}] bearer_type (string) optional — 'subaccount', 'account', 'all-proportional', 'all' bearer_subaccount (string) optional — subaccount code if bearer_type is 'subaccount'

public function createSplit(array $data): array;

listSplits

List all transaction splits.

public function listSplits(array $params = []): array;

getSplit

Retrieve a single split by ID.

public function getSplit(string $id): array;

updateSplit

Update a split's configuration.

public function updateSplit(string $id, array $data): array;

addSubaccountToSplit

Add or update a subaccount's share in a split.

public function addSubaccountToSplit(string $splitId, string $subaccountCode, int $share): array;

removeSubaccountFromSplit

Remove a subaccount from a split.

public function removeSubaccountFromSplit(string $splitId, string $subaccountCode): array;