Merchant (Charging to Platform) CSV Report

This report is provided to merchants operating on a platform that absorbs Forage's fees. Because the platform covers the fees, the merchant report omits them and shows only the transaction and payout details relevant to the merchant. For step-by-step setup instructions, see How to set up SFTP reports; for shared field definitions, file naming, and conventions that apply to every CSV report, see CSV report conventions. For background on the two fee models, see Understanding Forage reporting — Two fee models.

Each CSV report contains two reports by default: a Payout Transaction report and a Payout Summary report. A Transaction Log is also available on request.

Payout Transaction Report

A detailed breakdown of every individual payout transaction. The report includes unique transaction IDs, amounts, and timestamps. Because the platform covers Forage's fees on this flavor, fee fields are omitted from the merchant's report. This gives merchants a full audit trail to reconcile transactions and verify each payout.

Payout Transaction Report fields

The Payout Transaction Report includes the following fields. All field definitions are documented in CSV report conventions — Shared field definitions; for transaction_type and payment_method enum values, see Transaction type and payment method values.

Unlike the Charging-to-Merchant report, this report has no transaction_amount or forage_fee at the per-row level, because the platform absorbs those.

Payout Summary

An aggregated view of all transactions included in each payout over a given period. The merchant_net_settlement total should match the settlement amount Forage moved to your destination account for that day.

This flavor intentionally omits the aggregate-total columns (total_purchases, total_refunds, total_void_purchases, total_void_refunds, total_chargebacks, total_positive_adjustments, total_negative_adjustments, forage_fee) that appear in the Charging-to-Merchant flavor, because the platform absorbs the fees and tracks those rollups in the Platform CSV report instead.

Payout Summary fields

The Payout Summary uses only fields documented in CSV report conventions — Shared field definitions. The columns are:

Transaction Log (on request)

For what the Transaction Log contains and how to enable it, see CSV report conventions — Transaction Log. The fields included in the Merchant (Charging to Platform) flavor are below.

Transaction Log fields

The Transaction Log includes the following fields. All field definitions are documented in CSV report conventions — Shared field definitions.

Sample CSV

A zip archive of three sample CSV files for a Generic Merchant (Charging to Platform) Settlement Report is available below. CSVs are plain text, so you can open them in any spreadsheet tool (Excel, Numbers, Google Sheets, or any CSV reader).

Here's one Payout Transaction Report row in the delivered format:

merchant_id,fns_id,recorded_date,payout_issued_date,expected_deposit_date,payment_method,transaction_type,merchant_net_settlement,order_id,external_order_id,payment_id,refund_id,chargeback_id,merchant_payout_id,merchant_destination_account_ref,external_location_id,description,corporation_ref,merchant_group_ref
gxe37pc24y,9900099,2023-12-28T00:08:38.890Z,1/3/2024,1/4/2024,SNAP,Purchase,126.05,a9a7226jm8,ord-10293,mn0yo1orjw,,,jakqbi64tv,c45b20e98a,store-1187,Weekly grocery order,tp43855aag,o73bnhm6pn

• Sample file zip: Merchant-(Charging-to-Platform)-Report-Sample.zip

📘

Transaction types in samples

Sample reports show examples of every transaction type. You may not need all transaction types in your custom reports.