Skip to content

Commit 77ee726

Browse files
docs(types): improve settlement_detail field descriptions
1 parent 7d42546 commit 77ee726

2 files changed

Lines changed: 12 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: 190
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/lithic/types/settlement_detail.py

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,8 @@ class SettlementDetail(BaseModel):
5050

5151
event_tokens: List[str]
5252
"""
53-
Globally unique identifiers denoting the Events associated with this settlement.
53+
Array of globally unique identifiers for the financial events that comprise this
54+
settlement. Use these tokens to access detailed event-level information.
5455
"""
5556

5657
institution: str
@@ -85,7 +86,14 @@ class SettlementDetail(BaseModel):
8586
"""
8687

8788
transaction_token: str
88-
"""Globally unique identifier denoting the associated Transaction object."""
89+
"""Globally unique identifier denoting the associated transaction.
90+
91+
For settlement records with type `CLEARING`, `FINANCIAL`, or `NON-FINANCIAL`,
92+
this references a card transaction token. For settlement records with type
93+
`CHARGEBACK`, `REPRESENTMENT`, `PREARBITRATION`, `ARBITRATION`, or
94+
`COLLABORATION`, this references the dispute transaction token. May be null for
95+
certain settlement types.
96+
"""
8997

9098
transactions_gross_amount: int
9199
"""

0 commit comments

Comments
 (0)