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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._createable_api_resource import CreateableAPIResource
from stripe._list_object import ListObject
from stripe._listable_api_resource import ListableAPIResource
from stripe._request_options import RequestOptions
from stripe._stripe_object import StripeObject
from typing import ClassVar, Dict, List, Optional, cast
from typing_extensions import Literal, NotRequired, TypedDict, Unpack
class Request(
CreateableAPIResource["Request"], ListableAPIResource["Request"]
):
"""
Instructs Stripe to make a request on your behalf using the destination URL. The destination URL
is activated by Stripe at the time of onboarding. Stripe verifies requests with your credentials
provided during onboarding, and injects card details from the payment_method into the request.
Stripe redacts all sensitive fields and headers, including authentication credentials and card numbers,
before storing the request and response data in the forwarding Request object, which are subject to a
30-day retention period.
You can provide a Stripe idempotency key to make sure that requests with the same key result in only one
outbound request. The Stripe idempotency key provided should be unique and different from any idempotency
keys provided on the underlying third-party request.
Forwarding Requests are synchronous requests that return a response or time out according to
Stripe's limits.
Related guide: [Forward card details to third-party API endpoints](https://docs.stripe.com/payments/forwarding).
"""
OBJECT_NAME: ClassVar[Literal["forwarding.request"]] = "forwarding.request"
class RequestContext(StripeObject):
destination_duration: int
"""
The time it took in milliseconds for the destination endpoint to respond.
"""
destination_ip_address: str
"""
The IP address of the destination.
"""
class RequestDetails(StripeObject):
class Header(StripeObject):
name: str
"""
The header name.
"""
value: str
"""
The header value.
"""
body: str
"""
The body payload to send to the destination endpoint.
"""
headers: List[Header]
"""
The headers to include in the forwarded request. Can be omitted if no additional headers (excluding Stripe-generated ones such as the Content-Type header) should be included.
"""
http_method: Literal["POST"]
"""
The HTTP method used to call the destination endpoint.
"""
_inner_class_types = {"headers": Header}
class ResponseDetails(StripeObject):
class Header(StripeObject):
name: str
"""
The header name.
"""
value: str
"""
The header value.
"""
body: str
"""
The response body from the destination endpoint to Stripe.
"""
headers: List[Header]
"""
HTTP headers that the destination endpoint returned.
"""
status: int
"""
The HTTP status code that the destination endpoint returned.
"""
_inner_class_types = {"headers": Header}
class CreateParams(RequestOptions):
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`.
"""
payment_method: str
"""
The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.
"""
replacements: List[
Literal[
"card_cvc",
"card_expiry",
"card_number",
"cardholder_name",
"request_signature",
]
]
"""
The field kinds to be replaced in the forwarded request.
"""
request: "Request.CreateParamsRequest"
"""
The request body and headers to be sent to the destination endpoint.
"""
url: str
"""
The destination URL for the forwarded request. Must be supported by the config.
"""
class CreateParamsRequest(TypedDict):
body: NotRequired[str]
"""
The body payload to send to the destination endpoint.
"""
headers: NotRequired[List["Request.CreateParamsRequestHeader"]]
"""
The headers to include in the forwarded request. Can be omitted if no additional headers (excluding Stripe-generated ones such as the Content-Type header) should be included.
"""
class CreateParamsRequestHeader(TypedDict):
name: str
"""
The header name.
"""
value: str
"""
The header value.
"""
class ListParams(RequestOptions):
created: NotRequired["Request.ListParamsCreated"]
"""
Similar to other List endpoints, filters results based on created timestamp. You can pass gt, gte, lt, and lte timestamp values.
"""
ending_before: NotRequired[str]
"""
A pagination cursor to fetch the previous page of the list. The value must be a ForwardingRequest ID.
"""
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 pagination cursor to fetch the next page of the list. The value must be a ForwardingRequest ID.
"""
class ListParamsCreated(TypedDict):
gt: NotRequired[int]
"""
Return results where the `created` field is greater than this value.
"""
gte: NotRequired[int]
"""
Return results where the `created` field is greater than or equal to this value.
"""
lt: NotRequired[int]
"""
Return results where the `created` field is less than this value.
"""
lte: NotRequired[int]
"""
Return results where the `created` field is less than or equal to this value.
"""
class RetrieveParams(RequestOptions):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
created: int
"""
Time at which the object was created. Measured in seconds since the Unix epoch.
"""
id: str
"""
Unique identifier for the object.
"""
livemode: bool
"""
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
"""
metadata: Optional[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.
"""
object: Literal["forwarding.request"]
"""
String representing the object's type. Objects of the same type share the same value.
"""
payment_method: str
"""
The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.
"""
replacements: List[
Literal[
"card_cvc",
"card_expiry",
"card_number",
"cardholder_name",
"request_signature",
]
]
"""
The field kinds to be replaced in the forwarded request.
"""
request_context: Optional[RequestContext]
"""
Context about the request from Stripe's servers to the destination endpoint.
"""
request_details: Optional[RequestDetails]
"""
The request that was sent to the destination endpoint. We redact any sensitive fields.
"""
response_details: Optional[ResponseDetails]
"""
The response that the destination endpoint returned to us. We redact any sensitive fields.
"""
url: Optional[str]
"""
The destination URL for the forwarded request. Must be supported by the config.
"""
@classmethod
def create(cls, **params: Unpack["Request.CreateParams"]) -> "Request":
"""
Creates a ForwardingRequest object.
"""
return cast(
"Request",
cls._static_request(
"post",
cls.class_url(),
params=params,
),
)
@classmethod
async def create_async(
cls, **params: Unpack["Request.CreateParams"]
) -> "Request":
"""
Creates a ForwardingRequest object.
"""
return cast(
"Request",
await cls._static_request_async(
"post",
cls.class_url(),
params=params,
),
)
@classmethod
def list(
cls, **params: Unpack["Request.ListParams"]
) -> ListObject["Request"]:
"""
Lists all ForwardingRequest objects.
"""
result = cls._static_request(
"get",
cls.class_url(),
params=params,
)
if not isinstance(result, ListObject):
raise TypeError(
"Expected list object from API, got %s"
% (type(result).__name__)
)
return result
@classmethod
async def list_async(
cls, **params: Unpack["Request.ListParams"]
) -> ListObject["Request"]:
"""
Lists all ForwardingRequest objects.
"""
result = await cls._static_request_async(
"get",
cls.class_url(),
params=params,
)
if not isinstance(result, ListObject):
raise TypeError(
"Expected list object from API, got %s"
% (type(result).__name__)
)
return result
@classmethod
def retrieve(
cls, id: str, **params: Unpack["Request.RetrieveParams"]
) -> "Request":
"""
Retrieves a ForwardingRequest object.
"""
instance = cls(id, **params)
instance.refresh()
return instance
@classmethod
async def retrieve_async(
cls, id: str, **params: Unpack["Request.RetrieveParams"]
) -> "Request":
"""
Retrieves a ForwardingRequest object.
"""
instance = cls(id, **params)
await instance.refresh_async()
return instance
_inner_class_types = {
"request_context": RequestContext,
"request_details": RequestDetails,
"response_details": ResponseDetails,
}
|
