Forwarding 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.
The ForwardingRequest object
Attributes
- idstring
Unique identifier for the object.
- objectstring
String representing the object’s type. Objects of the same type share the same value.
- createdtimestamp
Time at which the object was created. Measured in seconds since the Unix epoch.
- livemodeboolean
Has the value
true
if the object exists in live mode or the valuefalse
if the object exists in test mode. - payment_
methodstring The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.
- replacementsarray of enums
The field kinds to be replaced in the forwarded request.
- request_
contextnullable object Context about the request from Stripe’s servers to the destination endpoint.
- request_
detailsnullable object The request that was sent to the destination endpoint. We redact any sensitive fields.
- response_
detailsnullable object The response that the destination endpoint returned to us. We redact any sensitive fields.
- urlnullable string
The destination URL for the forwarded request. Must be supported by the config.
Create a ForwardingRequest
Creates a ForwardingRequest object.
Parameters
- payment_
methodstringRequired The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.
- replacementsarray of enumsRequired
The field kinds to be replaced in the forwarded request.
- requestobjectRequired
The request body and headers to be sent to the destination endpoint.
- urlstringRequired
The destination URL for the forwarded request. Must be supported by the config.
Returns
Returns a ForwardingRequest object.
Retrieve a ForwardingRequest
Retrieves a ForwardingRequest object.
Parameters
No parameters.
Returns
Returns a ForwardingRequest object.
List all ForwardingRequests
Lists all ForwardingRequest objects.
Parameters
- createdobject
Similar to other List endpoints, filters results based on created timestamp. You can pass gt, gte, lt, and lte timestamp values.
- ending_
beforestring A pagination cursor to fetch the previous page of the list. The value must be a ForwardingRequest ID.
- limitinteger
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_
afterstring A pagination cursor to fetch the next page of the list. The value must be a ForwardingRequest ID.
Returns
Returns a list of ForwardingRequest objects.