stripe/stripe-python | Build 9489862430 | stripe/_balance_transaction.py | Coveralls

1

# -*- coding: utf-8 -*-

2

# File generated from our OpenAPI spec

10

    Literal,

11

    NotRequired,

12

    TypedDict,

13

    Unpack,

14

    TYPE_CHECKING,

15

16

23

        CustomerCashBalanceTransaction,

24

36

37

39

"""

40

    Balance transactions represent funds moving through your Stripe account.

41

    Stripe creates them for every type of transaction that enters or leaves your Stripe account balance.

42

43

    Related guide: [Balance transaction types](https://stripe.com/docs/reports/balance-transaction-types)

44

"""

45

47

        "balance_transaction"

48

49

53

        Amount of the fee, in cents.

54

"""

57

        ID of the Connect application that earned the fee.

58

"""

61

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

62

"""

65

        An arbitrary string attached to the object. Often useful for displaying to users.

66

"""

69

        Type of the fee, one of: `application_fee`, `payment_method_passthrough_fee`, `stripe_fee` or `tax`.

70

"""

71

75

        Only return transactions that were created during the given date interval.

76

"""

79

        Only return transactions in a certain currency. 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).

80

"""

83

        A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.

84

"""

87

        Specifies which fields in the response should be expanded.

88

"""

91

        A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

92

"""

95

        For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.

96

"""

99

        Only returns the original transaction.

100

"""

103

        A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

104

"""

107

        Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.

108

"""

109

113

        Minimum value to filter by (exclusive)

114

"""

117

        Minimum value to filter by (inclusive)

118

"""

121

        Maximum value to filter by (exclusive)

122

"""

125

        Maximum value to filter by (inclusive)

126

"""

127

131

        Specifies which fields in the response should be expanded.

132

"""

133

136

    Gross amount of this transaction (in cents (or local equivalent)). A positive value represents funds charged to another party, and a negative value represents funds sent to another party.

137

"""

140

    The date that the transaction's net funds become available in the Stripe balance.

141

"""

144

    Time at which the object was created. Measured in seconds since the Unix epoch.

145

"""

148

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

149

"""

152

    An arbitrary string attached to the object. Often useful for displaying to users.

153

"""

156

    If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the `amount` in currency A, multipled by the `exchange_rate`, equals the `amount` in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent's `amount` is `1000` and `currency` is `eur`. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction's `amount` is `1234`, its `currency` is `usd`, and the `exchange_rate` is `1.234`.

157

"""

160

    Fees (in cents (or local equivalent)) paid for this transaction. Represented as a positive integer when assessed.

161

"""

164

    Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction.

165

"""

168

    Unique identifier for the object.

169

"""

172

    Net impact to a Stripe balance (in cents (or local equivalent)). A positive value represents incrementing a Stripe balance, and a negative value decrementing a Stripe balance. You can calculate the net impact of a transaction on a balance by `amount` - `fee`

173

"""

176

    String representing the object's type. Objects of the same type share the same value.

177

"""

180

    Learn more about how [reporting categories](https://stripe.com/docs/reports/reporting-categories) can help you understand balance transactions from an accounting perspective.

181

"""

183

        ExpandableField[

184

            Union[

185

                "ApplicationFee",

186

                "Charge",

187

                "ConnectCollectionTransfer",

188

                "CustomerCashBalanceTransaction",

189

                "DisputeResource",

190

                "ApplicationFeeRefund",

191

                "Authorization",

192

                "IssuingDisputeResource",

193

                "Transaction",

194

                "Payout",

195

                "Refund",

196

                "ReserveTransaction",

197

                "TaxDeductedAtSource",

198

                "Topup",

199

                "Transfer",

200

                "Reversal",

201

202

203

205

    This transaction relates to the Stripe object.

206

"""

209

    The transaction's net funds status in the Stripe balance, which are either `available` or `pending`.

210

"""

212

        "adjustment",

213

        "advance",

214

        "advance_funding",

215

        "anticipation_repayment",

216

        "application_fee",

217

        "application_fee_refund",

218

        "charge",

219

        "climate_order_purchase",

220

        "climate_order_refund",

221

        "connect_collection_transfer",

222

        "contribution",

223

        "issuing_authorization_hold",

224

        "issuing_authorization_release",

225

        "issuing_dispute",

226

        "issuing_transaction",

227

        "obligation_outbound",

228

        "obligation_reversal_inbound",

229

        "payment",

230

        "payment_failure_refund",

231

        "payment_network_reserve_hold",

232

        "payment_network_reserve_release",

233

        "payment_refund",

234

        "payment_reversal",

235

        "payment_unreconciled",

236

        "payout",

237

        "payout_cancel",

238

        "payout_failure",

239

        "refund",

240

        "refund_failure",

241

        "reserve_transaction",

242

        "reserved_funds",

243

        "stripe_fee",

244

        "stripe_fx_fee",

245

        "tax_fee",

246

        "topup",

247

        "topup_reversal",

248

        "transfer",

249

        "transfer_cancel",

250

        "transfer_failure",

251

        "transfer_refund",

252

254

    Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead.

255

"""

256

259

        cls, **params: Unpack["BalanceTransaction.ListParams"]

260

    ) -> ListObject["BalanceTransaction"]:

261

"""

262

        Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

263

264

        Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.

265

"""

267

            "get",

268

            cls.class_url(),

269

            params=params,

270

273

                "Expected list object from API, got %s"

274

                % (type(result).__name__)

275

276

278

281

        cls, **params: Unpack["BalanceTransaction.ListParams"]

282

    ) -> ListObject["BalanceTransaction"]:

283

"""

284

        Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

285

286

        Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.

287

"""

289

            "get",

290

            cls.class_url(),

291

            params=params,

292

295

                "Expected list object from API, got %s"

296

                % (type(result).__name__)

297

298

300

303

        cls, id: str, **params: Unpack["BalanceTransaction.RetrieveParams"]

304

    ) -> "BalanceTransaction":

305

"""

306

        Retrieves the balance transaction with the given ID.

307

308

        Note that this endpoint previously used the path /v1/balance/history/:id.

309

"""

313

316

        cls, id: str, **params: Unpack["BalanceTransaction.RetrieveParams"]

317

    ) -> "BalanceTransaction":

318

"""

319

        Retrieves the balance transaction with the given ID.

320

321

        Note that this endpoint previously used the path /v1/balance/history/:id.

322

"""

326

stripe / stripe-python / 9489862430

Source File
Press 'n' to go to next uncovered line, 'b' for previous

1	# -- coding: utf-8 --
2	# File generated from our OpenAPI spec
3	from stripe._expandable_field import ExpandableField	1✔
4	from stripe._list_object import ListObject	1✔
5	from stripe._listable_api_resource import ListableAPIResource	1✔
6	from stripe._request_options import RequestOptions	1✔
7	from stripe._stripe_object import StripeObject	1✔
8	from typing import ClassVar, List, Optional, Union	1✔
9	from typing_extensions import (	1✔
10	Literal,
11	NotRequired,
12	TypedDict,
13	Unpack,
14	TYPE_CHECKING,
15	)
16
17	if TYPE_CHECKING:	1!
18	from stripe._application_fee import ApplicationFee	×
19	from stripe._application_fee_refund import ApplicationFeeRefund	×
20	from stripe._charge import Charge	×
21	from stripe._connect_collection_transfer import ConnectCollectionTransfer	×
22	from stripe._customer_cash_balance_transaction import (	×
23	CustomerCashBalanceTransaction,
24	)
25	from stripe._dispute import Dispute as DisputeResource	×
26	from stripe._payout import Payout	×
27	from stripe._refund import Refund	×
28	from stripe._reserve_transaction import ReserveTransaction	×
29	from stripe._reversal import Reversal	×
30	from stripe._tax_deducted_at_source import TaxDeductedAtSource	×
31	from stripe._topup import Topup	×
32	from stripe._transfer import Transfer	×
33	from stripe.issuing._authorization import Authorization	×
34	from stripe.issuing._dispute import Dispute as IssuingDisputeResource	×
35	from stripe.issuing._transaction import Transaction	×
36
37
38	class BalanceTransaction(ListableAPIResource["BalanceTransaction"]):	1✔
39	"""
40	Balance transactions represent funds moving through your Stripe account.
41	Stripe creates them for every type of transaction that enters or leaves your Stripe account balance.
42
43	Related guide: [Balance transaction types](https://stripe.com/docs/reports/balance-transaction-types)
44	"""
45
46	OBJECT_NAME: ClassVar[Literal["balance_transaction"]] = (	1✔
47	"balance_transaction"
48	)
49
50	class FeeDetail(StripeObject):	1✔
51	amount: int	1✔
52	"""	1✔
53	Amount of the fee, in cents.
54	"""
55	application: Optional[str]	1✔
56	"""	1✔
57	ID of the Connect application that earned the fee.
58	"""
59	currency: str	1✔
60	"""	1✔
61	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).
62	"""
63	description: Optional[str]	1✔
64	"""	1✔
65	An arbitrary string attached to the object. Often useful for displaying to users.
66	"""
67	type: str	1✔
68	"""	1✔
69	Type of the fee, one of: `application_fee`, `payment_method_passthrough_fee`, `stripe_fee` or `tax`.
70	"""
71
72	class ListParams(RequestOptions):	1✔
73	created: NotRequired["BalanceTransaction.ListParamsCreated\|int"]	1✔
74	"""	1✔
75	Only return transactions that were created during the given date interval.
76	"""
77	currency: NotRequired[str]	1✔
78	"""	1✔
79	Only return transactions in a certain currency. 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).
80	"""
81	ending_before: NotRequired[str]	1✔
82	"""	1✔
83	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
84	"""
85	expand: NotRequired[List[str]]	1✔
86	"""	1✔
87	Specifies which fields in the response should be expanded.
88	"""
89	limit: NotRequired[int]	1✔
90	"""	1✔
91	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
92	"""
93	payout: NotRequired[str]	1✔
94	"""	1✔
95	For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.
96	"""
97	source: NotRequired[str]	1✔
98	"""	1✔
99	Only returns the original transaction.
100	"""
101	starting_after: NotRequired[str]	1✔
102	"""	1✔
103	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
104	"""
105	type: NotRequired[str]	1✔
106	"""	1✔
107	Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.
108	"""
109
110	class ListParamsCreated(TypedDict):	1✔
111	gt: NotRequired[int]	1✔
112	"""	1✔
113	Minimum value to filter by (exclusive)
114	"""
115	gte: NotRequired[int]	1✔
116	"""	1✔
117	Minimum value to filter by (inclusive)
118	"""
119	lt: NotRequired[int]	1✔
120	"""	1✔
121	Maximum value to filter by (exclusive)
122	"""
123	lte: NotRequired[int]	1✔
124	"""	1✔
125	Maximum value to filter by (inclusive)
126	"""
127
128	class RetrieveParams(RequestOptions):	1✔
129	expand: NotRequired[List[str]]	1✔
130	"""	1✔
131	Specifies which fields in the response should be expanded.
132	"""
133
134	amount: int	1✔
135	"""	1✔
136	Gross amount of this transaction (in cents (or local equivalent)). A positive value represents funds charged to another party, and a negative value represents funds sent to another party.
137	"""
138	available_on: int	1✔
139	"""	1✔
140	The date that the transaction's net funds become available in the Stripe balance.
141	"""
142	created: int	1✔
143	"""	1✔
144	Time at which the object was created. Measured in seconds since the Unix epoch.
145	"""
146	currency: str	1✔
147	"""	1✔
148	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).
149	"""
150	description: Optional[str]	1✔
151	"""	1✔
152	An arbitrary string attached to the object. Often useful for displaying to users.
153	"""
154	exchange_rate: Optional[float]	1✔
155	"""	1✔
156	If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the `amount` in currency A, multipled by the `exchange_rate`, equals the `amount` in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent's `amount` is `1000` and `currency` is `eur`. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction's `amount` is `1234`, its `currency` is `usd`, and the `exchange_rate` is `1.234`.
157	"""
158	fee: int	1✔
159	"""	1✔
160	Fees (in cents (or local equivalent)) paid for this transaction. Represented as a positive integer when assessed.
161	"""
162	fee_details: List[FeeDetail]	1✔
163	"""	1✔
164	Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction.
165	"""
166	id: str	1✔
167	"""	1✔
168	Unique identifier for the object.
169	"""
170	net: int	1✔
171	"""	1✔
172	Net impact to a Stripe balance (in cents (or local equivalent)). A positive value represents incrementing a Stripe balance, and a negative value decrementing a Stripe balance. You can calculate the net impact of a transaction on a balance by `amount` - `fee`
173	"""
174	object: Literal["balance_transaction"]	1✔
175	"""	1✔
176	String representing the object's type. Objects of the same type share the same value.
177	"""
178	reporting_category: str	1✔
179	"""	1✔
180	Learn more about how [reporting categories](https://stripe.com/docs/reports/reporting-categories) can help you understand balance transactions from an accounting perspective.
181	"""
182	source: Optional[	1✔
183	ExpandableField[
184	Union[
185	"ApplicationFee",
186	"Charge",
187	"ConnectCollectionTransfer",
188	"CustomerCashBalanceTransaction",
189	"DisputeResource",
190	"ApplicationFeeRefund",
191	"Authorization",
192	"IssuingDisputeResource",
193	"Transaction",
194	"Payout",
195	"Refund",
196	"ReserveTransaction",
197	"TaxDeductedAtSource",
198	"Topup",
199	"Transfer",
200	"Reversal",
201	]
202	]
203	]
204	"""	1✔
205	This transaction relates to the Stripe object.
206	"""
207	status: str	1✔
208	"""	1✔
209	The transaction's net funds status in the Stripe balance, which are either `available` or `pending`.
210	"""
211	type: Literal[	1✔
212	"adjustment",
213	"advance",
214	"advance_funding",
215	"anticipation_repayment",
216	"application_fee",
217	"application_fee_refund",
218	"charge",
219	"climate_order_purchase",
220	"climate_order_refund",
221	"connect_collection_transfer",
222	"contribution",
223	"issuing_authorization_hold",
224	"issuing_authorization_release",
225	"issuing_dispute",
226	"issuing_transaction",
227	"obligation_outbound",
228	"obligation_reversal_inbound",
229	"payment",
230	"payment_failure_refund",
231	"payment_network_reserve_hold",
232	"payment_network_reserve_release",
233	"payment_refund",
234	"payment_reversal",
235	"payment_unreconciled",
236	"payout",
237	"payout_cancel",
238	"payout_failure",
239	"refund",
240	"refund_failure",
241	"reserve_transaction",
242	"reserved_funds",
243	"stripe_fee",
244	"stripe_fx_fee",
245	"tax_fee",
246	"topup",
247	"topup_reversal",
248	"transfer",
249	"transfer_cancel",
250	"transfer_failure",
251	"transfer_refund",
252	]
253	"""	1✔
254	Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead.
255	"""
256
257	@classmethod	1✔
258	def list(	1✔
259	cls, **params: Unpack["BalanceTransaction.ListParams"]
260	) -> ListObject["BalanceTransaction"]:
261	"""
262	Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.
263
264	Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.
265	"""
266	result = cls._static_request(	1✔
267	"get",
268	cls.class_url(),
269	params=params,
270	)
271	if not isinstance(result, ListObject):	1!
UNCOV 272	raise TypeError(	×
273	"Expected list object from API, got %s"
274	% (type(result).__name__)
275	)
276
277	return result	1✔
278
279	@classmethod	1✔
280	async def list_async(	1✔
281	cls, **params: Unpack["BalanceTransaction.ListParams"]
282	) -> ListObject["BalanceTransaction"]:
283	"""
284	Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.
285
286	Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.
287	"""
288	result = await cls._static_request_async(	1✔
289	"get",
290	cls.class_url(),
291	params=params,
292	)
293	if not isinstance(result, ListObject):	1!
UNCOV 294	raise TypeError(	×
295	"Expected list object from API, got %s"
296	% (type(result).__name__)
297	)
298
299	return result	1✔
300
301	@classmethod	1✔
302	def retrieve(	1✔
303	cls, id: str, **params: Unpack["BalanceTransaction.RetrieveParams"]
304	) -> "BalanceTransaction":
305	"""
306	Retrieves the balance transaction with the given ID.
307
308	Note that this endpoint previously used the path /v1/balance/history/:id.
309	"""
310	instance = cls(id, **params)	1✔
311	instance.refresh()	1✔
312	return instance	1✔
313
314	@classmethod	1✔
315	async def retrieve_async(	1✔
316	cls, id: str, **params: Unpack["BalanceTransaction.RetrieveParams"]
317	) -> "BalanceTransaction":
318	"""
319	Retrieves the balance transaction with the given ID.
320
321	Note that this endpoint previously used the path /v1/balance/history/:id.
322	"""
323	instance = cls(id, **params)	1✔
324	await instance.refresh_async()	1✔
325	return instance	1✔
326
327	_inner_class_types = {"fee_details": FeeDetail}	1✔

stripe / stripe-python / 9489862430

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous