VirtualAccountDriverInterface

Source: view src/Contracts/VirtualAccountDriverInterface.php

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

createVirtualAccount

Create a virtual/dedicated bank account for a customer. Virtual accounts allow customers to make bank transfers at any time; the gateway credits the merchant when a transfer is received. Expected $data keys: email (string) required — customer email name (string) required — customer full name reference (string) optional — unique caller-supplied reference preferred_bank (string) optional — preferred bank for the virtual account bvn (string) optional — required by some Nigerian gateways for compliance description (string) optional metadata (array) optional

public function createVirtualAccount(array $data): array;

getVirtualAccount

Retrieve an existing virtual account by its reference.

public function getVirtualAccount(string $reference): array;

listVirtualAccounts

List all virtual accounts with optional filters.

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

deactivateVirtualAccount

Deactivate / close a virtual account so it no longer accepts credits.

public function deactivateVirtualAccount(string $reference): array;