SubaccountDriverInterface

Source: view src/Contracts/SubaccountDriverInterface.php

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

createSubaccount

Create a subaccount on your integration. Expected $data keys: business_name (string) required — name of business settlement_bank (string) required — bank code for settlement account_number (string) required — bank account number percentage_charge (float) required — percentage the main account receives description (string) optional primary_contact_email (string) optional primary_contact_name (string) optional primary_contact_phone (string) optional metadata (string) optional — stringified JSON

public function createSubaccount(array $data): array;

listSubaccounts

List subaccounts available on your integration.

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

getSubaccount

Retrieve a single subaccount by ID or code.

public function getSubaccount(string $idOrCode): array;

updateSubaccount

Update a subaccount's details.

public function updateSubaccount(string $idOrCode, array $data): array;