Skip to content

Commit 7d85e57

Browse files
docs(api): improve SettlementDetail event_tokens and transaction_token descriptions
1 parent 2da5cf3 commit 7d85e57

2 files changed

Lines changed: 10 additions & 4 deletions

File tree

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 191
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic/lithic-0572da655d188e23459f2115b03b27040b4c4d3b47e4a86510803892d0d1b0aa.yml
3-
openapi_spec_hash: b615a0eb16502b4de874f9ae28491894
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic/lithic-a46ebb10f6bb217a591206f0574450c324f108dbd32a2d62727cd8186d85e94f.yml
3+
openapi_spec_hash: f320c173152f74b0799166b6ef5b82cd
44
config_hash: ac8326134e692f3f3bdec82396bbec80

src/resources/reports/reports.ts

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,8 @@ export interface SettlementDetail {
143143
disputes_gross_amount: number;
144144

145145
/**
146-
* Globally unique identifiers denoting the Events associated with this settlement.
146+
* Array of globally unique identifiers for the financial events that comprise this
147+
* settlement. Use these tokens to access detailed event-level information.
147148
*/
148149
event_tokens: Array<string>;
149150

@@ -191,7 +192,12 @@ export interface SettlementDetail {
191192
settlement_date: string;
192193

193194
/**
194-
* Globally unique identifier denoting the associated Transaction object.
195+
* Globally unique identifier denoting the associated transaction. For settlement
196+
* records with type `CLEARING`, `FINANCIAL`, or `NON-FINANCIAL`, this references a
197+
* card transaction token. For settlement records with type `CHARGEBACK`,
198+
* `REPRESENTMENT`, `PREARBITRATION`, `ARBITRATION`, or `COLLABORATION`, this
199+
* references the dispute transaction token. May be null for certain settlement
200+
* types.
195201
*/
196202
transaction_token: string;
197203

0 commit comments

Comments
 (0)