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
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._request_options import RequestOptions
from stripe._stripe_service import StripeService
from stripe._util import sanitize_id
from stripe.treasury._outbound_payment import OutboundPayment
from typing import List, cast
from typing_extensions import Literal, NotRequired, TypedDict
class OutboundPaymentService(StripeService):
class FailParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
class PostParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
class ReturnOutboundPaymentParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
returned_details: NotRequired[
"OutboundPaymentService.ReturnOutboundPaymentParamsReturnedDetails"
]
"""
Optional hash to set the return code.
"""
class ReturnOutboundPaymentParamsReturnedDetails(TypedDict):
code: NotRequired[
Literal[
"account_closed",
"account_frozen",
"bank_account_restricted",
"bank_ownership_changed",
"declined",
"incorrect_account_holder_name",
"invalid_account_number",
"invalid_currency",
"no_account",
"other",
]
]
"""
The return code to be set on the OutboundPayment object.
"""
class UpdateParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
tracking_details: "OutboundPaymentService.UpdateParamsTrackingDetails"
"""
Details about network-specific tracking information.
"""
class UpdateParamsTrackingDetails(TypedDict):
ach: NotRequired[
"OutboundPaymentService.UpdateParamsTrackingDetailsAch"
]
"""
ACH network tracking details.
"""
type: Literal["ach", "us_domestic_wire"]
"""
The US bank account network used to send funds.
"""
us_domestic_wire: NotRequired[
"OutboundPaymentService.UpdateParamsTrackingDetailsUsDomesticWire"
]
"""
US domestic wire network tracking details.
"""
class UpdateParamsTrackingDetailsAch(TypedDict):
trace_id: str
"""
ACH trace ID for funds sent over the `ach` network.
"""
class UpdateParamsTrackingDetailsUsDomesticWire(TypedDict):
chips: NotRequired[str]
"""
CHIPS System Sequence Number (SSN) for funds sent over the `us_domestic_wire` network.
"""
imad: NotRequired[str]
"""
IMAD for funds sent over the `us_domestic_wire` network.
"""
omad: NotRequired[str]
"""
OMAD for funds sent over the `us_domestic_wire` network.
"""
def update(
self,
id: str,
params: "OutboundPaymentService.UpdateParams",
options: RequestOptions = {},
) -> OutboundPayment:
"""
Updates a test mode created OutboundPayment with tracking details. The OutboundPayment must not be cancelable, and cannot be in the canceled or failed states.
"""
return cast(
OutboundPayment,
self._request(
"post",
"/v1/test_helpers/treasury/outbound_payments/{id}".format(
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
id: str,
params: "OutboundPaymentService.UpdateParams",
options: RequestOptions = {},
) -> OutboundPayment:
"""
Updates a test mode created OutboundPayment with tracking details. The OutboundPayment must not be cancelable, and cannot be in the canceled or failed states.
"""
return cast(
OutboundPayment,
await self._request_async(
"post",
"/v1/test_helpers/treasury/outbound_payments/{id}".format(
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
def fail(
self,
id: str,
params: "OutboundPaymentService.FailParams" = {},
options: RequestOptions = {},
) -> OutboundPayment:
"""
Transitions a test mode created OutboundPayment to the failed status. The OutboundPayment must already be in the processing state.
"""
return cast(
OutboundPayment,
self._request(
"post",
"/v1/test_helpers/treasury/outbound_payments/{id}/fail".format(
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
async def fail_async(
self,
id: str,
params: "OutboundPaymentService.FailParams" = {},
options: RequestOptions = {},
) -> OutboundPayment:
"""
Transitions a test mode created OutboundPayment to the failed status. The OutboundPayment must already be in the processing state.
"""
return cast(
OutboundPayment,
await self._request_async(
"post",
"/v1/test_helpers/treasury/outbound_payments/{id}/fail".format(
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
def post(
self,
id: str,
params: "OutboundPaymentService.PostParams" = {},
options: RequestOptions = {},
) -> OutboundPayment:
"""
Transitions a test mode created OutboundPayment to the posted status. The OutboundPayment must already be in the processing state.
"""
return cast(
OutboundPayment,
self._request(
"post",
"/v1/test_helpers/treasury/outbound_payments/{id}/post".format(
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
async def post_async(
self,
id: str,
params: "OutboundPaymentService.PostParams" = {},
options: RequestOptions = {},
) -> OutboundPayment:
"""
Transitions a test mode created OutboundPayment to the posted status. The OutboundPayment must already be in the processing state.
"""
return cast(
OutboundPayment,
await self._request_async(
"post",
"/v1/test_helpers/treasury/outbound_payments/{id}/post".format(
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
def return_outbound_payment(
self,
id: str,
params: "OutboundPaymentService.ReturnOutboundPaymentParams" = {},
options: RequestOptions = {},
) -> OutboundPayment:
"""
Transitions a test mode created OutboundPayment to the returned status. The OutboundPayment must already be in the processing state.
"""
return cast(
OutboundPayment,
self._request(
"post",
"/v1/test_helpers/treasury/outbound_payments/{id}/return".format(
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
async def return_outbound_payment_async(
self,
id: str,
params: "OutboundPaymentService.ReturnOutboundPaymentParams" = {},
options: RequestOptions = {},
) -> OutboundPayment:
"""
Transitions a test mode created OutboundPayment to the returned status. The OutboundPayment must already be in the processing state.
"""
return cast(
OutboundPayment,
await self._request_async(
"post",
"/v1/test_helpers/treasury/outbound_payments/{id}/return".format(
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
|
