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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._list_object import ListObject
from stripe._request_options import RequestOptions
from stripe._stripe_service import StripeService
from stripe._transfer import Transfer
from stripe._transfer_reversal_service import TransferReversalService
from stripe._util import sanitize_id
from typing import Dict, List, cast
from typing_extensions import Literal, NotRequired, TypedDict
class TransferService(StripeService):
def __init__(self, requestor):
super().__init__(requestor)
self.reversals = TransferReversalService(self._requestor)
class CreateParams(TypedDict):
amount: NotRequired[int]
"""
A positive integer in cents (or local equivalent) representing how much to transfer.
"""
currency: str
"""
Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies).
"""
description: NotRequired[str]
"""
An arbitrary string attached to the object. Often useful for displaying to users.
"""
destination: str
"""
The ID of a connected Stripe account. [See the Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
metadata: NotRequired[Dict[str, str]]
"""
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
"""
source_transaction: NotRequired[str]
"""
You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. [See the Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-availability) for details.
"""
source_type: NotRequired[Literal["bank_account", "card", "fpx"]]
"""
The source balance to use for this transfer. One of `bank_account`, `card`, or `fpx`. For most users, this will default to `card`.
"""
transfer_group: NotRequired[str]
"""
A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.
"""
class ListParams(TypedDict):
created: NotRequired["TransferService.ListParamsCreated|int"]
"""
Only return transfers that were created during the given date interval.
"""
destination: NotRequired[str]
"""
Only return transfers for the destination specified by this account ID.
"""
ending_before: NotRequired[str]
"""
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.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
limit: NotRequired[int]
"""
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
"""
starting_after: NotRequired[str]
"""
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.
"""
transfer_group: NotRequired[str]
"""
Only return transfers with the specified transfer group.
"""
class ListParamsCreated(TypedDict):
gt: NotRequired[int]
"""
Minimum value to filter by (exclusive)
"""
gte: NotRequired[int]
"""
Minimum value to filter by (inclusive)
"""
lt: NotRequired[int]
"""
Maximum value to filter by (exclusive)
"""
lte: NotRequired[int]
"""
Maximum value to filter by (inclusive)
"""
class RetrieveParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
class UpdateParams(TypedDict):
description: NotRequired[str]
"""
An arbitrary string attached to the object. Often useful for displaying to users.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
metadata: NotRequired["Literal['']|Dict[str, str]"]
"""
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
"""
def list(
self,
params: "TransferService.ListParams" = {},
options: RequestOptions = {},
) -> ListObject[Transfer]:
"""
Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.
"""
return cast(
ListObject[Transfer],
self._request(
"get",
"/v1/transfers",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: "TransferService.ListParams" = {},
options: RequestOptions = {},
) -> ListObject[Transfer]:
"""
Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.
"""
return cast(
ListObject[Transfer],
await self._request_async(
"get",
"/v1/transfers",
base_address="api",
params=params,
options=options,
),
)
def create(
self,
params: "TransferService.CreateParams",
options: RequestOptions = {},
) -> Transfer:
"""
To send funds from your Stripe account to a connected account, you create a new transfer object. Your [Stripe balance](https://stripe.com/docs/api#balance) must be able to cover the transfer amount, or you'll receive an “Insufficient Funds” error.
"""
return cast(
Transfer,
self._request(
"post",
"/v1/transfers",
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
params: "TransferService.CreateParams",
options: RequestOptions = {},
) -> Transfer:
"""
To send funds from your Stripe account to a connected account, you create a new transfer object. Your [Stripe balance](https://stripe.com/docs/api#balance) must be able to cover the transfer amount, or you'll receive an “Insufficient Funds” error.
"""
return cast(
Transfer,
await self._request_async(
"post",
"/v1/transfers",
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
transfer: str,
params: "TransferService.RetrieveParams" = {},
options: RequestOptions = {},
) -> Transfer:
"""
Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information.
"""
return cast(
Transfer,
self._request(
"get",
"/v1/transfers/{transfer}".format(
transfer=sanitize_id(transfer),
),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
transfer: str,
params: "TransferService.RetrieveParams" = {},
options: RequestOptions = {},
) -> Transfer:
"""
Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information.
"""
return cast(
Transfer,
await self._request_async(
"get",
"/v1/transfers/{transfer}".format(
transfer=sanitize_id(transfer),
),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
transfer: str,
params: "TransferService.UpdateParams" = {},
options: RequestOptions = {},
) -> Transfer:
"""
Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
This request accepts only metadata as an argument.
"""
return cast(
Transfer,
self._request(
"post",
"/v1/transfers/{transfer}".format(
transfer=sanitize_id(transfer),
),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
transfer: str,
params: "TransferService.UpdateParams" = {},
options: RequestOptions = {},
) -> Transfer:
"""
Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
This request accepts only metadata as an argument.
"""
return cast(
Transfer,
await self._request_async(
"post",
"/v1/transfers/{transfer}".format(
transfer=sanitize_id(transfer),
),
base_address="api",
params=params,
options=options,
),
)
|
