Settlement Batch Summary

Settlement Batch Summary: Generate

See also the Settlement Batch Summary 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.

Ruby

result = gateway.settlement_batch_summary.generate(
    :settlement_date => Time.now.strftime("%Y-%m-%d"),
    :group_by_custom_field => "custom_field_1"
) if result.success?
    p result.settlement_batch_summary.records
end

Parameters

:group_by_custom_fieldString

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

:settlement_dateString

A string representing the date of the settlement batch.

Validation Errors

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