Skip to content

Reports

Reports

Last updated: (timestamp)

Reports

reports
Domain Types
Settlement Detail
SettlementDetailobject
ShowShow
tokenstring

Globally unique identifier denoting the Settlement Detail.

formatuuid
account_tokenstring

The most granular ID the network settles with (e.g., ICA for Mastercard, FTSRE for Visa).

formatuuid
card_program_tokenstring

Globally unique identifier denoting the card program that the associated Transaction occurred on.

formatuuid
card_tokenstring

Globally unique identifier denoting the card that the associated Transaction occurred on.

formatuuid
createdstring

Date and time when the transaction first occurred. UTC time zone.

formatdate-time
currencystring

Three-character alphabetic ISO 4217 code.

maxLength3
minLength3
disputes_gross_amountnumber

The total gross amount of disputes settlements.

event_tokensarray of string

Globally unique identifiers denoting the Events associated with this settlement.

institutionstring

The most granular ID the network settles with (e.g., ICA for Mastercard, FTSRE for Visa).

interchange_fee_extended_precisionnumber

The total amount of interchange in six-digit extended precision.

interchange_gross_amountnumber

The total amount of interchange.

networkenum
Accepts one of the following: "INTERLINK", "MAESTRO", "MASTERCARD", 2 more

Card network where the transaction took place.

Hide ParametersShow Parameters
"INTERLINK"
"MAESTRO"
"MASTERCARD"
"UNKNOWN"
"VISA"
other_fees_detailsobject

The total gross amount of other fees by type.

Hide ParametersShow Parameters
ISAnumber
optional
other_fees_gross_amountnumber

Total amount of gross other fees outside of interchange.

report_datestring

Date of when the report was first generated.

settlement_datestring

Date of when money movement is triggered for the transaction. One exception applies - for Mastercard dual message settlement, this is the settlement advisement date, which is distinct from the date of money movement.

transaction_tokenstring

Globally unique identifier denoting the associated Transaction object.

formatuuid
transactions_gross_amountnumber

The total amount of settlement impacting transactions (excluding interchange, fees, and disputes).

typeenum
Accepts one of the following: "ADJUSTMENT", "ARBITRATION", "CHARGEBACK", 6 more

The type of settlement record.

Hide ParametersShow Parameters
"ADJUSTMENT"
"ARBITRATION"
"CHARGEBACK"
"CLEARING"
"FEE"
"FINANCIAL"
"NON-FINANCIAL"
"PREARBITRATION"
"REPRESENTMENT"
updatedstring

Date and time when the transaction first occurred. UTC time zone.

formatdate-time
fee_descriptionstring
optional

Network's description of a fee, only present on records with type FEE.

Settlement Report
SettlementReportobject
ShowShow
createdstring

Date and time when the transaction first occurred. UTC time zone.

formatdate-time
currencystring
deprecated

3-character alphabetic ISO 4217 code. (This field is deprecated and will be removed in a future version of the API.)

maxLength3
minLength3
detailsarray of currencystringdisputes_gross_amountnumberinstitutionstringinterchange_gross_amountnumbernetworkenumother_fees_gross_amountnumbersettled_net_amountnumbertransactions_gross_amountnumberSettlementSummaryDetails
disputes_gross_amountnumber
deprecated

The total gross amount of disputes settlements. (This field is deprecated and will be removed in a future version of the API. To compute total amounts, Lithic recommends that customers sum the relevant settlement amounts found within details.)

interchange_gross_amountnumber
deprecated

The total amount of interchange. (This field is deprecated and will be removed in a future version of the API. To compute total amounts, Lithic recommends that customers sum the relevant settlement amounts found within details.)

is_completeboolean

Indicates that all data expected on the given report date is available.

other_fees_gross_amountnumber
deprecated

Total amount of gross other fees outside of interchange. (This field is deprecated and will be removed in a future version of the API. To compute total amounts, Lithic recommends that customers sum the relevant settlement amounts found within details.)

report_datestring

Date of when the report was first generated.

settled_net_amountnumber
deprecated

The total net amount of cash moved. (net value of settled_gross_amount, interchange, fees). (This field is deprecated and will be removed in a future version of the API. To compute total amounts, Lithic recommends that customers sum the relevant settlement amounts found within details.)

transactions_gross_amountnumber
deprecated

The total amount of settlement impacting transactions (excluding interchange, fees, and disputes). (This field is deprecated and will be removed in a future version of the API. To compute total amounts, Lithic recommends that customers sum the relevant settlement amounts found within details.)

updatedstring

Date and time when the transaction first occurred. UTC time zone.

formatdate-time
Settlement Summary Details
SettlementSummaryDetailsobject
ShowShow
currencystring
optional

3-character alphabetic ISO 4217 code.

maxLength3
minLength3
disputes_gross_amountnumber
optional

The total gross amount of disputes settlements.

institutionstring
optional

The most granular ID the network settles with (e.g., ICA for Mastercard, FTSRE for Visa).

interchange_gross_amountnumber
optional

The total amount of interchange.

networkenum
optional
Accepts one of the following: "INTERLINK", "MAESTRO", "MASTERCARD", 2 more

Card network where the transaction took place

Hide ParametersShow Parameters
"INTERLINK"
"MAESTRO"
"MASTERCARD"
"UNKNOWN"
"VISA"
other_fees_gross_amountnumber
optional

Total amount of gross other fees outside of interchange.

settled_net_amountnumber
optional

The total net amount of cash moved. (net value of settled_gross_amount, interchange, fees).

transactions_gross_amountnumber
optional

The total amount of settlement impacting transactions (excluding interchange, fees, and disputes).

ReportsSettlement

reports.settlement
Methods
List settlement details
get/v1/reports/settlement/details/{report_date}

List details.

Get settlement summary
get/v1/reports/settlement/summary/{report_date}

Get the settlement report for a specified report date. Not available in sandbox.

ReportsSettlementNetwork Totals

reports.settlement.network_totals
Methods
Get network total
get/v1/reports/settlement/network_totals/{token}

Retrieve a specific network total record by token. Not available in sandbox.

List network totals
get/v1/reports/settlement/network_totals

List network total records with optional filters. Not available in sandbox.