Forwarding Requests

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.

Was this section helpful? Yes No

Create a ForwardingRequest

POST / v1 / forwarding / requests

Retrieve a ForwardingRequest

GET / v1 / forwarding / requests /:id

List all ForwardingRequests

GET / v1 / forwarding / requests

The ForwardingRequest object

Attributes

id string Unique identifier for the object.
object string, value is "forwarding.request" String representing the object’s type. Objects of the same type share the same value.
created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
livemode boolean If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
metadata nullable map Preview feature Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
payment _ method string The ID of the object containing the card details that were inserted into the forwarded request. Can be a PaymentMethod ( pm_), Source ( src_), Card ( card_), or Issuing Card ( ic_).
replacements array of enums The field kinds to be replaced in the forwarded request. Possible enum values card_cvc Replace the card cvc field card_expiry Replace the card expiry fields like month and year card_number Replace the card number field cardholder_name Replace the cardholder name field request_signature Calculate and replace the request signature field
request _ context nullable object Context about the request from Stripe’s servers to the destination endpoint.
request _ details nullable object The request that was sent to the destination endpoint. We redact any sensitive fields.
response _ details nullable object The response that the destination endpoint returned to us. We redact any sensitive fields.
url nullable string The destination URL for the forwarded request. Must be supported by the config.

The ForwardingRequest object

Create a ForwardingRequest

POST / v1 / forwarding / requests

Creates a ForwardingRequest object.

Parameters

payment _ method string Required The ID of the object containing the card details in Stripe’s vault. Accepted object types include: PaymentMethod ( pm_) with type card or card_present, Source ( src_) with an underlying card, Card ( card_), and Issuing Card ( ic_). Forwarding previously consumed PaymentMethods is allowed.
replacements array of enums Required The field kinds to be replaced in the forwarded request. Possible enum values card_cvc Replace the card cvc field card_expiry Replace the card expiry fields like month and year card_number Replace the card number field cardholder_name Replace the cardholder name field request_signature Calculate and replace the request signature field
request object Required The request body and headers to be sent to the destination endpoint.
url string Required The destination URL for the forwarded request. Must be supported by the config.
metadata map Preview feature Set of key-value pairs 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.

Returns

Returns a ForwardingRequest object.

Response