Transaction reports

Use a Transaction report to reconcile your accounting books against the Forage ledger.

📘
Note on Unique IDs
Unless stated otherwise, all 10-character IDs in this report are unique within their field but may overlap with IDs from other fields. For example, each order_id is unique from other order_ids, but those same 10 characters can occur in different fields.

Here's what a Transaction report contains:

Column name	Type	Description	Example value
`merchant_id`	string	A 10-character identifier for a merchant, provided by Forage.	`a0i404a0020`
`fns_id`	string	A merchant’s unique FNS number.	`1234567`
`recorded_date`	string	The date and time of the transaction, formatted as an ISO 8601 string in the UTC timezone.	`2024-11-04T14:00:00Z`
`payment_method`	string	The funding type of the transaction. One of: - `SNAP` - `EBT_Cash` - `Credit_Debit` - `Payfac_Credit_Debit` - `HSA` - `FSA` If the `transaction_type` is one of the following, `payment_method` will be `""`: - `Positive_adjustment` - `Negative_adjustment` - `Balance_Inquiry_Fee` - `Refund_Processing_Fee`	`SNAP`
`transaction_type`	string	The type of the transaction. Must be one of the following: - `Purchase` - `Purchase_With_Cash_Back` - `Refund` - `Withdrawal` - `Chargeback` - `Void_Purchase` - `Void_Refund` - `Negative_adjustment` - `Positive_adjustment` - `Balance_Inquiry_Fee` - `Refund_Processing_Fee`	`Refund`
`transaction_amount`	number	The total amount in USD charged, voided, or refunded to the customer.	`28.15`
`merchant_net_settlement`	number	The net amount sent to the merchant, equal to the sum of purchases minus refunds, chargebacks, fees, and any other deductions.	`27.03`
`platform_net_settlement`	number	If the transaction was processed via a platform that hosts multiple merchants, then this is the net amount sent to the host platform, equal to the sum of purchases minus refunds, chargebacks, fees, and any other deductions. This column is not included if a platform was not involved in the transaction.	`0.00`
`order_id`	string	For Fully Hosted and Custom integrations, a unique identifier for the order associated with the transaction. This value is not returned for SDK integrations.	`b7b04a4b5c`
`external_order_id`	string	A unique identifier for the order as created by the merchant or platform (not Forage). This typically corresponds to an identifier in the merchant or platform’s database, so it can be used as a reference to look up the transaction.	`1f2ee410-5b47-4130-aec2-40f5eb2108f5`
`payment_id`	string	A unique identifier for the payment transaction.	`4be98347f6`
`refund_id`	string	If the `transaction_type` is `Refund`, a unique identifier for the refund transaction. This value is blank for all other transaction types.	`cbe72b8320`
`chargeback_id`	string	If the `transaction_type` is `Chargeback`, a unique identifier for the chargeback transaction. This value is blank for all other transaction types.	`d200020430`
`merchant_destination_account_ref`	string	A unique reference hash for the bank account that received funds settlement for this payment.	`20b0b0123`
`external_location_id`	string	A unique identifier, provided by the merchant or platform (not Forage), that indicates the physical fulfillment location for the order. For example, this field could specify which location of a grocery store chain fulfilled an order.	`6e3b2ff7-51c8-4c64-befa-2eac90f7c3e9`
`description`	string	A description of the transaction, as provided by the merchant or platform when the transaction was created.	`An EBT SNAP payment`
`corporation_ref`	string	A 10-character identifier for a corporation, provided by Forage. Note: This field is only accessible through delivered reports, not the Forage API.	`3hsk173gs8`
`merchant_group_ref`	string	A 10-character identifier for a merchant group, provided by Forage. Note: This field is only accessible through delivered reports, not the Forage API.	`6sjqk816dj`
`forage_fee`	number	The amount of Forage fees applied to the transaction.	`28.15`

📘Note on Unique IDs

📘
Note on Unique IDs