Returned directly or within a successful result object from the following requests:

Attributes
records

An array of maps representing settlement batches.

Examples

Generating Settlement Batch Summary

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.

Records data structure

Below is an example of the data structure returned by records.

PHP
Copy
Copied
(
    [0] => Array
        (
            [kind] => sale
            [cardType] => Mastercard
            [merchantAccountId] => your_merchant_account_id
            [count] => 1
            [amountSettled] => 100.00
            [custom_field_1] => your_first_custom_value
        )

    [1] => Array
        (
            [kind] => sale
            [cardType] => Mastercard
            [merchantAccountId] => your_merchant_account_id
            [count] => 5
            [amountSettled] => 250.00
            [custom_field_1] => your_second_custom_value
        )

)

Still have questions?

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