Settlement report specification

Settlement reports are in comma-separated value format (CSV). The following is the specification of each of the fields in the report.

Field	Order	Type	Meaning
payment_service_transaction_reconciliation_id	1	String	For transactions that originated from the system, this is the reconciliation ID on the transaction. This is a Base62-encoded version of the transaction ID. This shorter version of the transaction ID is passed as not every service connected to supports the full length of the ID. For transactions that originated outside of the system, this field is set to the value received from the payment service. In most cases, this is the merchant reference, but in some cases, this may be empty.
transaction_id	2	UUID	The transaction ID that this line applies to.
payment_service_transaction_id	3	String	The transaction ID as returned by the payment service.
payment_service_id	4	UUID	The UUID of the connection through which the transaction associated with this record was sent. The connection can be queried via the API. It is not set if the transaction cannot be found in the system.
payment_service_definition_id	5	String	The definition ID of the connection through which the transaction associated with this record was sent. This defines the service provider followed by a dash followed by the payment method used (for example stripe-card). It is not set if the transaction cannot be found in the system.
payment_service_display_name	6	String	The display name of the connection through which the transaction associated with this record was sent. The display name is set up by the merchant when configuring the connection. It is not set if the transaction cannot be found in the system.
journal_type	7	String	The journal type of the entry. Where it is recognized, it is mapped to a standardized value, for example settlement. For any values not recognized, this field is other.
raw_journal_type	8	String	The original value for the journal type as received from the payment service’s report.
payment_service_transaction_created_at	9	ISO8061 string	The timestamp at which the transaction was created in the payment service.
posted_at	10	ISO8061 string	The timestamp at which the transaction was reported as settled in the imported report.
processing_amount_plain	11	Decimal	The amount of the transaction expressed in the processing_currency. This is the customer facing amount. This is also the amount sent to the payment service.
processing_currency	12	ISO4217 string	The currency of the transaction. This is the customer facing currency. This is also the currency sent to the payment service.
exchange_rate	13	Decimal	The reported applied exchange rate of the processing currency to the settlement currency.
currency	14	ISO4217 string	The currency in which the gross amount, fees, and net amounts are defined.
gross_credit_plain	15	Decimal	The gross credit amount (expressed in currency) for the merchant. This pertains to settlement or any credit line type reported by the payment service.
net_credit_plain	16	Decimal	The net credit amount (expressed in currency) for the merchant. This pertains to settlement or any credit line type reported by the payment service after deduction of fees.
gross_debit_plain	17	Decimal	The gross debit amount (expressed in currency) for the merchant. This pertains to refunds or any debit line type reported by the payment service.
net_debit_plain	18	Decimal	The net debit amount (expressed in currency) for the merchant. This pertains to refunds or any debit line type reported by the payment service.
fee_markup_plain	19	Decimal	If provided in the reporting, this column shows the markup applied by the acquirer (expressed in currency).
fee_interchange_plain	20	Decimal	If provided in the reporting, this column shows the transaction level interchange (expressed in currency).
fee_scheme_plain	21	Decimal	If provided in the reporting, this column shows the transaction scheme fee (expressed in currency).
fee_total_plain	22	Decimal	This column shows the cost of the transaction (expressed in currency). It specifies the total fee paid on the transaction. This is the difference between the net settled amount and the captured amount. For acquirers that charge a blend rate, this column is filled out. For alternative forms of payment, this column is filled out as well. Usually, for settlements, this is gross_credit_plain - net_credit_plain, but this depends on the payment service report. However, for refunds, this is usually equals to net_debit_plain - gross_debit_plain.
method	23	String	Payment method used. An attempt is made to map this to standardized values where recognized. For any values not recognized, this field is other.
raw_method	24	String	The original value for the payment method as received from the payment service’s report.
scheme	25	String	The scheme used in the transaction if the method is card. An attempt is made to map this to standardized values where recognized. For any values not recognized, this field is other.
raw_scheme	26	String	The original value for the scheme as received from the payment service’s report.
batch	27	String	The batch number of the imported settlement data.
report_id	28	UUID	The ID of the report from which this line of data came from.
raw_report_ids	29	List[String]	The list of raw IDs given to the raw payment service report imported where this transaction line was taken from. Can be used to determine the original payment service report the line was taken from.
ingested_at	30	ISO8061 string	The timestamp at which this line was ingested.
description	31	String	Raw string describing this entry coming from the payment service’s report.
transaction_external_identifier	32	String	The external identifier of the transaction.
transaction_metadata	33	JSON	Additional information about the transaction.
report_payment_service_id	34	UUID	The UUID of the connection through which the report was created. The connection can be queried via the API. It can differ from the value in payment_service_id if the transaction associated with this record (if any) was sent through a different connection.
report_payment_service_definition_id	35	String	The definition ID of the connection through which the report was created. This defines the service provider followed by a dash followed by the payment method used (for example stripe-card). It can differ from the value in payment_service_definition_id if the transaction associated with this record (if any) was sent through a different connection.
report_payment_service_display_name	36	String	The display name of the connection through which the report was created. The display name is set up by the merchant when configuring the connection. It can differ from the value in payment_service_display_name if the transaction associated with this record (if any) was sent through a different connection.
payment_service_modification_reference	37	String	A unique identifier, assigned by the payment service, that links a follow-up operation (such as a capture, refund, or cancellation) back to the original payment transaction.

Additional fields

The right to add additional data as new columns after the ones documented here is reserved. Please ensure report parsers can handle any additional data being added at a later date.