1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._expandable_field import ExpandableField
from stripe._stripe_object import StripeObject
from typing import ClassVar, Optional
from typing_extensions import Literal, TYPE_CHECKING
if TYPE_CHECKING:
from stripe._balance_transaction import BalanceTransaction
from stripe._customer import Customer
from stripe._payment_intent import PaymentIntent
from stripe._refund import Refund
class CustomerCashBalanceTransaction(StripeObject):
"""
Customers with certain payments enabled have a cash balance, representing funds that were paid
by the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions
represent when funds are moved into or out of this balance. This includes funding by the customer, allocation
to payments, and refunds to the customer.
"""
OBJECT_NAME: ClassVar[Literal["customer_cash_balance_transaction"]] = (
"customer_cash_balance_transaction"
)
class AdjustedForOverdraft(StripeObject):
balance_transaction: ExpandableField["BalanceTransaction"]
"""
The [Balance Transaction](https://stripe.com/docs/api/balance_transactions/object) that corresponds to funds taken out of your Stripe balance.
"""
linked_transaction: ExpandableField["CustomerCashBalanceTransaction"]
"""
The [Cash Balance Transaction](https://stripe.com/docs/api/cash_balance_transactions/object) that brought the customer balance negative, triggering the clawback of funds.
"""
class AppliedToPayment(StripeObject):
payment_intent: ExpandableField["PaymentIntent"]
"""
The [Payment Intent](https://stripe.com/docs/api/payment_intents/object) that funds were applied to.
"""
class Funded(StripeObject):
class BankTransfer(StripeObject):
class EuBankTransfer(StripeObject):
bic: Optional[str]
"""
The BIC of the bank of the sender of the funding.
"""
iban_last4: Optional[str]
"""
The last 4 digits of the IBAN of the sender of the funding.
"""
sender_name: Optional[str]
"""
The full name of the sender, as supplied by the sending bank.
"""
class GbBankTransfer(StripeObject):
account_number_last4: Optional[str]
"""
The last 4 digits of the account number of the sender of the funding.
"""
sender_name: Optional[str]
"""
The full name of the sender, as supplied by the sending bank.
"""
sort_code: Optional[str]
"""
The sort code of the bank of the sender of the funding
"""
class JpBankTransfer(StripeObject):
sender_bank: Optional[str]
"""
The name of the bank of the sender of the funding.
"""
sender_branch: Optional[str]
"""
The name of the bank branch of the sender of the funding.
"""
sender_name: Optional[str]
"""
The full name of the sender, as supplied by the sending bank.
"""
class UsBankTransfer(StripeObject):
network: Optional[Literal["ach", "domestic_wire_us", "swift"]]
"""
The banking network used for this funding.
"""
sender_name: Optional[str]
"""
The full name of the sender, as supplied by the sending bank.
"""
eu_bank_transfer: Optional[EuBankTransfer]
gb_bank_transfer: Optional[GbBankTransfer]
jp_bank_transfer: Optional[JpBankTransfer]
reference: Optional[str]
"""
The user-supplied reference field on the bank transfer.
"""
type: Literal[
"eu_bank_transfer",
"gb_bank_transfer",
"jp_bank_transfer",
"mx_bank_transfer",
"us_bank_transfer",
]
"""
The funding method type used to fund the customer balance. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
"""
us_bank_transfer: Optional[UsBankTransfer]
_inner_class_types = {
"eu_bank_transfer": EuBankTransfer,
"gb_bank_transfer": GbBankTransfer,
"jp_bank_transfer": JpBankTransfer,
"us_bank_transfer": UsBankTransfer,
}
bank_transfer: BankTransfer
_inner_class_types = {"bank_transfer": BankTransfer}
class RefundedFromPayment(StripeObject):
refund: ExpandableField["Refund"]
"""
The [Refund](https://stripe.com/docs/api/refunds/object) that moved these funds into the customer's cash balance.
"""
class TransferredToBalance(StripeObject):
balance_transaction: ExpandableField["BalanceTransaction"]
"""
The [Balance Transaction](https://stripe.com/docs/api/balance_transactions/object) that corresponds to funds transferred to your Stripe balance.
"""
class UnappliedFromPayment(StripeObject):
payment_intent: ExpandableField["PaymentIntent"]
"""
The [Payment Intent](https://stripe.com/docs/api/payment_intents/object) that funds were unapplied from.
"""
adjusted_for_overdraft: Optional[AdjustedForOverdraft]
applied_to_payment: Optional[AppliedToPayment]
created: int
"""
Time at which the object was created. Measured in seconds since the Unix epoch.
"""
currency: str
"""
Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
"""
customer: ExpandableField["Customer"]
"""
The customer whose available cash balance changed as a result of this transaction.
"""
ending_balance: int
"""
The total available cash balance for the specified currency after this transaction was applied. Represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
"""
funded: Optional[Funded]
id: str
"""
Unique identifier for the object.
"""
livemode: bool
"""
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
"""
net_amount: int
"""
The amount by which the cash balance changed, represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance.
"""
object: Literal["customer_cash_balance_transaction"]
"""
String representing the object's type. Objects of the same type share the same value.
"""
refunded_from_payment: Optional[RefundedFromPayment]
transferred_to_balance: Optional[TransferredToBalance]
type: Literal[
"adjusted_for_overdraft",
"applied_to_payment",
"funded",
"funding_reversed",
"refunded_from_payment",
"return_canceled",
"return_initiated",
"transferred_to_balance",
"unapplied_from_payment",
]
"""
The type of the cash balance transaction. New types may be added in future. See [Customer Balance](https://stripe.com/docs/payments/customer-balance#types) to learn more about these types.
"""
unapplied_from_payment: Optional[UnappliedFromPayment]
_inner_class_types = {
"adjusted_for_overdraft": AdjustedForOverdraft,
"applied_to_payment": AppliedToPayment,
"funded": Funded,
"refunded_from_payment": RefundedFromPayment,
"transferred_to_balance": TransferredToBalance,
"unapplied_from_payment": UnappliedFromPayment,
}
|
