Settlement reports
Settlement report specification
Settlement reports
Settlement report specification
Our 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 our system, this will be the reconciliation ID on the transaction. This is a Base62-encoded version of the transaction ID. We pass this shorter version of the transaction ID as not every service we connect to supports the full length of the ID. For transactions that originated outside of our system, this field will be set to the value we received from the payment service. In most cases this will be the merchant reference, but in some cases this may be empty |
transaction_id | 2 | UUID | The Gr4vy 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 was sent. The ID of a connection can be queried via the API. |
payment_service_definition_id | 5 | String | The unique ID of the payment service used, for example stripe-card. This defines the service provider followed by a dash followed by the payment method used. |
payment_service_display_name | 6 | String | The display name of the connection through which the transaction was sent. The display name is set up by the merchant when configuring the connection. |
journal_type | 7 | String | The journal type of the entry. Where it is recognized we will map this to a standardized value, for example settlement. For any values not recognized this field will be empty. |
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 at in payment service. |
posted_at | 10 | ISO8061 string | The timestamp at which the transaction was reported as settled in the ingested report. |
processing_amount_plain | 11 | Decimal | The amount of the transaction expressed in the processing_currency. This is the customer facing amount. This will also be the amount sent by Gr4vy to the payment service. |
processing_currency | 12 | ISO4217 string | The currency of the transaction. This is the customer facing currency. This will also be the currency sent by Gr4vy 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), this column 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 will be filled out. For alternative forms of payment this column will be filled out as well. Usually, this is gross_credit - net_credit but we this depends per payment service report. |
method | 23 | String | Payment method used. We will try to map this to a Gr4vy value where recognized, otherwise we will return the raw value received from the payment service’s report. |
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”. IMPORTANT: This is not a standardized value, it’s just what is reported by the payment service. We will try to map this to a Gr4vy value where recognized, otherwise we will return the raw value received from the payment service’s report. |
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 ingested settlement data. |
report_id | 28 | UUID | The Gr4vy 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 ingested by Gr4vy 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. |
Additional fields
We reserve the right to add additional data as new columns after the ones documented here. Please ensure your report parses can handle any additional data being added at a later date.
Was this page helpful?