SilverStripe\Omnipay\GatewayInfo::maxExcessCaptureAmount
Get the max excess capture amount for the given gateway and an optional currency.
Some payment providers allow capturing a slightly higher amount than was authorized. If $200.00 was authorized and maxExcessCaptureAmount returns `70`, you're allowed to capture at max $270.00, unless further restricted by maxExcessCapturePercent. To get the correct max-capture amount, both maxExcessCapturePercent and maxExcessCaptureAmount have to be considered.
Signature
public function maxExcessCaptureAmount(string
$gateway,
[string
$currency = NULL] )
Parameters
$gateway
— string- the gateway name
$currency
— string- the currency to look up. Defaults to `null` and is only needed when the config contains
amounts for different currencies.
Returns
- int|string
- the max excess amount or `-1` if the excess amount isn't limited (only limited by percentage)