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.

  1. Callback
  2. Promise
gateway.settlementBatchSummary.generate({
  settlementDate: "2012-01-01",
  groupByCustomField: "custom_field_1"
}, (err, result) => {
  console.log(result.settlementBatchSummary.records);
});
Parameters
groupByCustomFieldString
A string representing a transaction's custom field that you wish to group by.
settlementDateString
A string representing the date of the settlement batch.

Validation Errorsanchor

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