Skip to content

BalanceDriverInterface

Source: view src/Contracts/BalanceDriverInterface.php

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

getBalance

Get the available balance on the integration / account.

public function getBalance(?string $currency = null): array;

getLedger

Get the ledger balance (total balance including pending settlements).

public function getLedger(?string $currency = null): array;