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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._stripe_service import StripeService
from stripe._util import sanitize_id
from typing import Optional, cast
from typing_extensions import TYPE_CHECKING
if TYPE_CHECKING:
from stripe._list_object import ListObject
from stripe._payout import Payout
from stripe._request_options import RequestOptions
from stripe.params._payout_cancel_params import PayoutCancelParams
from stripe.params._payout_create_params import PayoutCreateParams
from stripe.params._payout_list_params import PayoutListParams
from stripe.params._payout_retrieve_params import PayoutRetrieveParams
from stripe.params._payout_reverse_params import PayoutReverseParams
from stripe.params._payout_update_params import PayoutUpdateParams
class PayoutService(StripeService):
def list(
self,
params: Optional["PayoutListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Payout]":
"""
Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you. The payouts return in sorted order, with the most recently created payouts appearing first.
"""
return cast(
"ListObject[Payout]",
self._request(
"get",
"/v1/payouts",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: Optional["PayoutListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Payout]":
"""
Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you. The payouts return in sorted order, with the most recently created payouts appearing first.
"""
return cast(
"ListObject[Payout]",
await self._request_async(
"get",
"/v1/payouts",
base_address="api",
params=params,
options=options,
),
)
def create(
self,
params: "PayoutCreateParams",
options: Optional["RequestOptions"] = None,
) -> "Payout":
"""
To send funds to your own bank account, create a new payout object. Your [Stripe balance](https://docs.stripe.com/api#balance) must cover the payout amount. If it doesn't, you receive an “Insufficient Funds” error.
If your API key is in test mode, money won't actually be sent, though every other action occurs as if you're in live mode.
If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The [balance object](https://docs.stripe.com/api#balance_object) details available and pending amounts by source type.
"""
return cast(
"Payout",
self._request(
"post",
"/v1/payouts",
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
params: "PayoutCreateParams",
options: Optional["RequestOptions"] = None,
) -> "Payout":
"""
To send funds to your own bank account, create a new payout object. Your [Stripe balance](https://docs.stripe.com/api#balance) must cover the payout amount. If it doesn't, you receive an “Insufficient Funds” error.
If your API key is in test mode, money won't actually be sent, though every other action occurs as if you're in live mode.
If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The [balance object](https://docs.stripe.com/api#balance_object) details available and pending amounts by source type.
"""
return cast(
"Payout",
await self._request_async(
"post",
"/v1/payouts",
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
payout: str,
params: Optional["PayoutRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Payout":
"""
Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list. Stripe returns the corresponding payout information.
"""
return cast(
"Payout",
self._request(
"get",
"/v1/payouts/{payout}".format(payout=sanitize_id(payout)),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
payout: str,
params: Optional["PayoutRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Payout":
"""
Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list. Stripe returns the corresponding payout information.
"""
return cast(
"Payout",
await self._request_async(
"get",
"/v1/payouts/{payout}".format(payout=sanitize_id(payout)),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
payout: str,
params: Optional["PayoutUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Payout":
"""
Updates the specified payout by setting the values of the parameters you pass. We don't change parameters that you don't provide. This request only accepts the metadata as arguments.
"""
return cast(
"Payout",
self._request(
"post",
"/v1/payouts/{payout}".format(payout=sanitize_id(payout)),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
payout: str,
params: Optional["PayoutUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Payout":
"""
Updates the specified payout by setting the values of the parameters you pass. We don't change parameters that you don't provide. This request only accepts the metadata as arguments.
"""
return cast(
"Payout",
await self._request_async(
"post",
"/v1/payouts/{payout}".format(payout=sanitize_id(payout)),
base_address="api",
params=params,
options=options,
),
)
def cancel(
self,
payout: str,
params: Optional["PayoutCancelParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Payout":
"""
You can cancel a previously created payout if its status is pending. Stripe refunds the funds to your available balance. You can't cancel automatic Stripe payouts.
"""
return cast(
"Payout",
self._request(
"post",
"/v1/payouts/{payout}/cancel".format(
payout=sanitize_id(payout),
),
base_address="api",
params=params,
options=options,
),
)
async def cancel_async(
self,
payout: str,
params: Optional["PayoutCancelParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Payout":
"""
You can cancel a previously created payout if its status is pending. Stripe refunds the funds to your available balance. You can't cancel automatic Stripe payouts.
"""
return cast(
"Payout",
await self._request_async(
"post",
"/v1/payouts/{payout}/cancel".format(
payout=sanitize_id(payout),
),
base_address="api",
params=params,
options=options,
),
)
def reverse(
self,
payout: str,
params: Optional["PayoutReverseParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Payout":
"""
Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US and Canadian bank accounts. If the payout is manual and in the pending status, use /v1/payouts/:id/cancel instead.
By requesting a reversal through /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account authorizes the debit on the bank account and that no other authorization is required.
"""
return cast(
"Payout",
self._request(
"post",
"/v1/payouts/{payout}/reverse".format(
payout=sanitize_id(payout),
),
base_address="api",
params=params,
options=options,
),
)
async def reverse_async(
self,
payout: str,
params: Optional["PayoutReverseParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Payout":
"""
Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US and Canadian bank accounts. If the payout is manual and in the pending status, use /v1/payouts/:id/cancel instead.
By requesting a reversal through /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account authorizes the debit on the bank account and that no other authorization is required.
"""
return cast(
"Payout",
await self._request_async(
"post",
"/v1/payouts/{payout}/reverse".format(
payout=sanitize_id(payout),
),
base_address="api",
params=params,
options=options,
),
)
|
