Stripe | Financial Infrastructure to Grow Your Revenue

Stripe | Financial Infrastructure to Grow Your Revenue

4466 articles

Create a ForwardingRequest


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

Retrieve a ForwardingRequest

GET / v1 / forwarding / requests /:id

Retrieves a ForwardingRequest object.

Parameters

No parameters.

Returns

Returns a ForwardingRequest object.

Response

List all ForwardingRequests

GET / v1 / forwarding / requests

Lists all ForwardingRequest objects.

Parameters

  • created object Similar to other List endpoints, filters results based on created timestamp. You can pass gt, gte, lt, and lte timestamp values.
  • ending _ before string A pagination cursor to fetch the previous page of the list. The value must be a ForwardingRequest ID.
  • limit integer A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  • starting _ after string 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.

Response

Last verified 2026-09-24

Is this helpful?