stripe/stripe-python | Build 9650619862 | 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

37

38

40

"""

41

    Balance transactions represent funds moving through your Stripe account.

42

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

43

44

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

45

"""

46

48

        "balance_transaction"

49

50

54

        Amount of the fee, in cents.

55

"""

58

        ID of the Connect application that earned the fee.

59

"""

62

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

63

"""

66

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

67

"""

70

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

71

"""

72

76

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

77

"""

80

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

81

"""

84

        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.

85

"""

88

        Specifies which fields in the response should be expanded.

89

"""

92

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

93

"""

96

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

97

"""

100

        Only returns the original transaction.

101

"""

104

        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.

105

"""

108

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

109

"""

110

114

        Minimum value to filter by (exclusive)

115

"""

118

        Minimum value to filter by (inclusive)

119

"""

122

        Maximum value to filter by (exclusive)

123

"""

126

        Maximum value to filter by (inclusive)

127

"""

128

132

        Specifies which fields in the response should be expanded.

133

"""

134

137

    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.

138

"""

141

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

142

"""

145

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

146

"""

149

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

150

"""

153

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

154

"""

157

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

158

"""

161

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

162

"""

165

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

166

"""

169

    Unique identifier for the object.

170

"""

173

    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`

174

"""

177

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

178

"""

181

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

182

"""

184

        ExpandableField[

185

            Union[

186

                "ApplicationFee",

187

                "Charge",

188

                "ConnectCollectionTransfer",

189

                "CustomerCashBalanceTransaction",

190

                "DisputeResource",

191

                "ApplicationFeeRefund",

192

                "Authorization",

193

                "IssuingDisputeResource",

194

                "Transaction",

195

                "Payout",

196

                "PlatformTaxFee",

197

                "Refund",

198

                "ReserveTransaction",

199

                "TaxDeductedAtSource",

200

                "Topup",

201

                "Transfer",

202

                "Reversal",

203

204

205

207

    This transaction relates to the Stripe object.

208

"""

211

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

212

"""

214

        "adjustment",

215

        "advance",

216

        "advance_funding",

217

        "anticipation_repayment",

218

        "application_fee",

219

        "application_fee_refund",

220

        "charge",

221

        "climate_order_purchase",

222

        "climate_order_refund",

223

        "connect_collection_transfer",

224

        "contribution",

225

        "issuing_authorization_hold",

226

        "issuing_authorization_release",

227

        "issuing_dispute",

228

        "issuing_transaction",

229

        "obligation_outbound",

230

        "obligation_reversal_inbound",

231

        "payment",

232

        "payment_failure_refund",

233

        "payment_network_reserve_hold",

234

        "payment_network_reserve_release",

235

        "payment_refund",

236

        "payment_reversal",

237

        "payment_unreconciled",

238

        "payout",

239

        "payout_cancel",

240

        "payout_failure",

241

        "refund",

242

        "refund_failure",

243

        "reserve_transaction",

244

        "reserved_funds",

245

        "stripe_fee",

246

        "stripe_fx_fee",

247

        "tax_fee",

248

        "topup",

249

        "topup_reversal",

250

        "transfer",

251

        "transfer_cancel",

252

        "transfer_failure",

253

        "transfer_refund",

254

256

    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.

257

"""

258

261

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

262

    ) -> ListObject["BalanceTransaction"]:

263

"""

264

        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.

265

266

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

267

"""

269

            "get",

270

            cls.class_url(),

271

            params=params,

272

275

                "Expected list object from API, got %s"

276

                % (type(result).__name__)

277

278

280

283

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

284

    ) -> ListObject["BalanceTransaction"]:

285

"""

286

        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.

287

288

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

289

"""

291

            "get",

292

            cls.class_url(),

293

            params=params,

294

297

                "Expected list object from API, got %s"

298

                % (type(result).__name__)

299

300

302

305

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

306

    ) -> "BalanceTransaction":

307

"""

308

        Retrieves the balance transaction with the given ID.

309

310

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

311

"""

315

318

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

319

    ) -> "BalanceTransaction":

320

"""

321

        Retrieves the balance transaction with the given ID.

322

323

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

324

"""

328

stripe / stripe-python / 9650619862

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

stripe / stripe-python / 9650619862

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