settlement_report.updated

wbhk

Occurs when a settlement report is created or updated.

Payload

event_type

const

enum

required

The type of event that occurred.

Allowed:

created

date-time

required

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

currency

string

required

length between 3 and 3

deprecated

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

details

array of objects

required

details*

disputes_gross_amount

integer

required

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_amount

integer

required

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_complete

boolean

required

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

other_fees_gross_amount

integer

required

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_date

string

required

Date of when the report was first generated.

settled_net_amount

integer

required

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_amount

integer

required

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.)

updated

date-time

required

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

Response

200

Return a 200 status to indicate that the data was received successfully