Merchant (Charging to Merchant) CSV Report

This report applies to merchants directly responsible for Forage's fees instead of the platform covering them. Because the merchant is charged directly, the report offers a detailed breakdown of fees at both the per-transaction and per-payout levels. 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, fees, and timestamps, giving 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.

Field
`merchant_id`
`fns_id`
`recorded_date`
`payout_issued_date`
`expected_deposit_date`
`payment_method`
`transaction_type`
`transaction_amount`
`forage_fee`
`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`

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. The Payout Summary covers total payout amounts, overall fees, and net values, supporting high-level reconciliation and financial reporting.

Payout Summary fields

In addition to the shared fields documented in CSV report conventions — Shared field definitions, the Payout Summary includes the following report-specific aggregate totals:

Field	Description	Sample
`total_purchases`	The total amount in USD of all the purchases included in this payout.	`180.98`
`total_refunds`	The total amount in USD of all the refunds included in this payout.	`0.00`
`total_void_purchases`	The total amount in USD debited from the merchant ledger for purchases that Forage voided after the transaction was recorded.	`1.12`
`total_void_refunds`	The total amount in USD credited back to the merchant ledger for refunds that Forage voided after the transaction was recorded.	`0.22`
`total_chargebacks`	The total amount in USD of refunds paid to customers as the result of dispute resolutions during this payout period. Distinct from and not included in `total_refunds`.	`0.00`
`total_positive_adjustments`	If any, the total amount in USD added to the settlement (for example, when Forage corrects a previous settlement).	`0.00`
`total_negative_adjustments`	If any, the total amount in USD deducted from the settlement (for example, when Forage corrects a previous settlement).	`0.00`

The full set of Payout Summary columns is:

Field
`merchant_payout_id`
`merchant_id`
`fns_id`
`payout_issued_date`
`total_purchases`
`total_refunds`
`total_void_purchases`
`total_void_refunds`
`total_chargebacks`
`total_positive_adjustments`
`total_negative_adjustments`
`forage_fee`
`merchant_net_settlement`
`merchant_destination_account_ref`

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 Merchant) 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.

Field
`merchant_id`
`fns_id`
`recorded_date`
`payment_method`
`transaction_type`
`transaction_amount`
`merchant_net_settlement`
`platform_net_settlement`
`order_id`
`external_order_id`
`payment_id`
`refund_id`
`chargeback_id`
`merchant_destination_account_ref`
`external_location_id`
`description`
`corporation_ref`
`merchant_group_ref`

Sample CSV

A zip archive of three sample CSV files for a Generic Merchant (Charging to Merchant) 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,transaction_amount,forage_fee,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,3.96,122.09,a9a7226jm8,ord-10293,mn0yo1orjw,,,jakqbi64tv,c45b20e98a,store-1187,Weekly grocery order,tp43855aag,o73bnhm6pn

Sample file zip: Merchant-(Charging-to-Merchant)-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.