Settlement Report CSV Extract Specification

Description: Learn about the Settlement report CSV extract, including the file format, column definitions, and how extract fields correspond to fields in the Customer Hub.

For information about generating and using the report, visit the Settlement Report.

---

File Format

Property	Value
File Type	CSV (comma-separated values)
Text Qualifier	Double quotes (") around every field, including numeric fields
Header Row	Yes — first row contains column names in quotes
Row Terminator	CRLF (\r\n)
Granularity	One row per Batch Number per Transaction Type — i.e., a single batch produces multiple rows (one for settled, one for payout, plus additional rows if refunds/chargebacks/adjustments/etc. apply to that batch)
Sort Order	Grouped by Merchant ID, then Batch Number

File Naming Convention

CSV extract files use the following naming convention: 

{Merchant Name}_{Generation Date:YYYYMMDD}_Settlement_Report.csv

Note: Replace "Merchant Name" with the merchant's name and "Generation Date" with the date the extract was generated.

Delivery SLA

Settlement report extract files are delivered daily during morning hours Eastern Time (ET).

Delivery may be delayed or skipped on weekends and holidays due to the payment processor's settlement schedule. In these cases, extract availability aligns with the timing of settlement batches.

Note: This behavior is consistent with the report's Payout Date, where funds may take an additional 1–3 business days to appear in your bank account due to weekends or holidays.

Column Specification

Fields are listed in file column order.

#	Column Name (extract)	Maps to UI field	Format / Notes	Example
1	Merchant ID	Merchant ID	10-digit numeric string, zero-padded	0099887766
2	Merchant Name	Merchant Name	DBA/location name	Bayview Lodge Reception
3	Parent Name	Parent Name	Name of the parent entity on the MID	Coastal Getaways Ltd
4	Country	Country	ISO country code three-letter (alpha-3) codes	GBR
5	Batch Closed Date	Batch Closed Date	YYYY-MM-DD. For batched-type rows	2026-04-30
6	Batch Number	Batch Number	Composite string: {Merchant ID}-{Batch Closed Date:YYYYMMDD}-{4-digit batch sequence}.	0099887766-20260430-1042
7	Payout Date	Payout Date	YYYY-MM-DD	2026-05-01
8	Transaction Type	Transaction Type	Lowercase in the extract. Can be settled, refund, reject, adjustment, chargeback, payout, batched, reversal (EU), service fee (EU), reserves (EU)	settled
9	Deposit Currency	Deposit Currency	Three-letter ISO currency code	GBP
10	Gross Amount	Gross Amount	Decimal, 2dp. Total of sales transactions before deductions, for that batch/transaction-type row	74.00
11	Bank Fees	Bank Fees	Decimal, 2dp.  Blank on payout rows; populated (including 0.00) on settled rows.	0.00 (settled row) / (blank) (payout row)
12	Net Amount	Net Amount	Decimal, 2dp. Gross Amount minus Bank Fees	74.00
13	Transaction Count	Transaction Count	Integer. Number of underlying transactions rolled into this row	3
14	Parent Name	Parent Name	Name of the parent entity on the MID	Coastal Getaways Ltd
15	Country	Country	ISO country code three-letter (alpha-3) codes	GBR
16	Batch Closed Date	Batch Closed Date	YYYY-MM-DD. For batched-type rows	2026-04-30
6	Batch Number	Batch Number	Composite string: {Merchant ID}-{Batch Closed Date:YYYYMMDD}-{4-digit batch sequence}.	0099887766-20260430-1042
7	Payout Date	Payout Date	YYYY-MM-DD	2026-05-01
8	Transaction Type	Transaction Type	Lowercase in the extract. Can be settled, refund, reject, adjustment, chargeback, payout, batched, reversal (EU), service fee (EU), reserves (EU)	settled
9	Deposit Currency	Deposit Currency	Three-letter ISO currency code	GBP
10	Gross Amount	Gross Amount	Decimal, 2dp. Total of sales transactions before deductions, for that batch/transaction-type row	74.00
11	Bank Fees	Bank Fees	Decimal, 2dp.  Blank on payout rows; populated (including 0.00) on settled rows.	0.00 (settled row) / (blank) (payout row)
12	Net Amount	Net Amount	Decimal, 2dp. Gross Amount minus Bank Fees	74.00
13	Transaction Count	Transaction Count	Integer. Number of underlying transactions rolled into this row	3

Example CSV Record

"0099887766","Bayview Lodge Reception","Coastal Getaways Ltd","GBR","2026-04-30","0099887766-20260430-1042","2026-05-01","settled","GBP","74.00","0.00","74.00","3"

"0099887766","Bayview Lodge Reception","Coastal Getaways Ltd","GBR","2026-04-30","0099887766-20260430-1042","2026-05-01","payout","GBP","74.00","","74.00","3"