See also the SettlementBatchSummary response object.

The settlement batch summary displays the total sales and credits for each batch for a particular date. The transactions can be grouped by a single custom field's values.

PHP
Copy
Copied
$today = new Datetime;
$result = $gateway->settlementBatchSummary()->generate(
  $today->format("Y-m-d"),
  "custom_field_1"
);

if ($result->success) {
  var_dump($result->settlementBatchSummary->records);
}
This code snippet now uses gateway instance methods instead of class-level methods. Learn more.
Parameters
'groupByCustomField' string

A string representing a transaction's custom field that you wish to group by.

'settlementDate' required, string

A string representing the date of the settlement batch.

Validation Errors

If you call this method with incorrect arguments, you may receive validation errors.

Still have questions?

If you can’t find an answer, contact our Support team