Sample - Stripe API
GET/v1/forwarding/requests/{id}

Retrieve a forwarding request

Retrieves a ForwardingRequest by its identifier. Use expand to request expanded fields in the returned object. The response includes the destination URL, payment method, replacement configuration, and redacted request and response details.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
idstringrequired
The unique identifier of the ForwardingRequest. Maximum 5000 characters.
expandarray<string>optional
Fields to expand in the response. Each value can be up to 5000 characters.

2 status codes
200Returns the ForwardingRequest, including its identifier, destination URL, payment method, replacements, and redacted request and response details.
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
idstringrequired
Unique identifier for the object.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadataobjectoptional
Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:forwarding.request
payment_methodstringrequired
The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.
replacementsarray<string>required
The field kinds to be replaced in the forwarded request.
request_contextobjectoptional
Context about the request from Stripe's servers to the destination endpoint.
request_detailsobjectoptional
The request that was sent to the destination endpoint. We redact any sensitive fields.
response_detailsobjectoptional
The response that the destination endpoint returned to us. We redact any sensitive fields.
urlstringoptional
The destination URL for the forwarded request. Must be supported by the config.
defaultReturned when the request cannot be processed; the response contains an error object with an error type and related details.
errorobjectrequired

Error handling

id must be a string no longer than 5000 characters that identifies a ForwardingRequest. Each expand value must also be no longer than 5000 characters.