Reports

Settlement Batch Summaries

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. 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
Arguments

  1. The date on which the batches were settled.
  2. Optional The custom field you wish to aggregate the results by.

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

  1. Ruby
[
    {
        :custom_field_1 => "your_first_custom_value",
        :card_type => "Mastercard",
        :count => "24",
        :merchant_account_id => "your_merchant_account_id",
        :kind => "sale",
        :amount_settled => "1200.00"
    },
    {
        :custom_field_1 => "your_second_custom_value",
        :card_type => "Mastercard",
        :count => "42",
        :merchant_account_id => "your_merchant_account_id",
        :kind => "sale",
        :amount_settled => "1234.00"
    }
]

See alsoAnchorIcon


If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more