Stripe: Create a Forwarding Request

← Forwarding operations · Get started

Operation stripe.postforwardingrequests

Provider route: POST /v1/forwarding/requests. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/stripe with npm, or alter-sdk-stripe with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { StripeIntegration } from "@alter-ai/stripe";

async function execute(input: Parameters<StripeIntegration["forwarding"]["postForwardingRequests"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new StripeIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.forwarding.postForwardingRequests(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_stripe import StripeIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = StripeIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.forwarding.post_forwarding_requests(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
headers	object	Optional	Additional keys: not allowed
headers.Idempotency-Key	string	Optional	Minimum length: 1 Maximum length: 255
body	object	Required within parent	Additional keys: not allowed
body.expand	array	Optional	Specifies which fields in the response should be expanded.
body.expand[]	string	Each item	Maximum length: 5000
body.metadata	object	Optional	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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. Additional keys: see wildcard field
body.metadata.*	string	Additional keys
body.payment_method	string	Required within parent	The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed. Maximum length: 5000
body.replacements	array	Required within parent	The field kinds to be replaced in the forwarded request.
body.replacements[]	string	Each item	One of: card_cvc, card_expiry, card_number, cardholder_name, request_signature
body.request	object	Optional	The request body and headers to be sent to the destination endpoint.
body.request.body	string	Optional	Maximum length: 5000
body.request.headers	array	Optional
body.request.headers[]	object	Each item
body.request.headers[].name	string	Required within parent	Maximum length: 5000
body.request.headers[].value	string	Required within parent	Maximum length: 5000
body.url	string	Required within parent	The destination URL for the forwarded request. Must be supported by the config. Maximum length: 5000

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Create a Forwarding Request — response body

Referenced models: Create a Forwarding Request — response body

Schemas

Create a Forwarding Request — response body

Field	Type	Presence	Description and constraints
$	object	Root	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).
created	JSON	Required within parent
created (anyOf 1)	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadata	JSON	Optional
metadata (anyOf 1)	object	Alternative	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. Additional keys: see wildcard field
metadata (anyOf 1).*	string	Additional keys	Maximum length: 500
metadata (anyOf 2)	null	Alternative
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: forwarding.request
payment_method	string	Required within parent	The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed. Maximum length: 5000
replacements	array	Required within parent	The field kinds to be replaced in the forwarded request.
replacements[]	string	Each item	Known values: card_cvc, card_expiry, card_number, cardholder_name, request_signature
request_context	JSON	Optional
request_context (anyOf 1)	JSON	Alternative	Context about the request from Stripe's servers to the destination endpoint.
request_context (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a Forwarding Request — response body — request context value Metadata about the forwarded request
request_context (anyOf 2)	null	Alternative
request_details	JSON	Optional
request_details (anyOf 1)	JSON	Alternative	The request that was sent to the destination endpoint. We redact any sensitive fields.
request_details (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a ForwardingRequest — response body — request_details / value / http_method: POST
request_details (anyOf 2)	null	Alternative
response_details	JSON	Optional
response_details (anyOf 1)	JSON	Alternative	The response that the destination endpoint returned to us. We redact any sensitive fields.
response_details (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a Forwarding Request — response body — response details value body, headers, status
response_details (anyOf 2)	null	Alternative
url	JSON	Optional
url (anyOf 1)	string	Alternative	The destination URL for the forwarded request. Must be supported by the config. Maximum length: 5000
url (anyOf 2)	null	Alternative

Referenced models: Create a Forwarding Request — response body — request context value Metadata about the forwarded request, Create a ForwardingRequest — response body — request_details / value / http_method: POST, Create a Forwarding Request — response body — response details value body, headers, status

Create a Forwarding Request — response body — request context value Metadata about the forwarded request

Field	Type	Presence	Description and constraints
$	object	Root	Metadata about the forwarded request.
destination_duration	JSON	Required within parent
destination_duration (anyOf 1)	integer	Alternative	The time it took in milliseconds for the destination endpoint to respond.
destination_duration (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
destination_ip_address	string	Required within parent	The IP address of the destination. Maximum length: 5000

Create a ForwardingRequest — response body — request_details / value / http_method: POST

Field	Type	Presence	Description and constraints
$	object	Root	Details about the request forwarded to the destination endpoint.
body	string	Required within parent	The body payload to send to the destination endpoint. Maximum length: 5000
headers	array	Required within parent	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.
headers[]	Model	Each item	Expand Create a ForwardingRequest — response body — request_details / value / http_method: POST headers item
http_method	string	Required within parent	The HTTP method used to call the destination endpoint. Known values: POST

Referenced models: Create a ForwardingRequest — response body — request_details / value / http_method: POST headers item

Create a Forwarding Request — response body — response details value body, headers, status

Field	Type	Presence	Description and constraints
$	object	Root	Details about the response from the destination endpoint.
body	string	Required within parent	The response body from the destination endpoint to Stripe. Maximum length: 5000
headers	array	Required within parent	HTTP headers that the destination endpoint returned.
headers[]	Model	Each item	Expand Create a ForwardingRequest — response body — request_details / value / http_method: POST headers item
status	JSON	Required within parent
status (anyOf 1)	integer	Alternative	The HTTP status code that the destination endpoint returned.
status (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Create a ForwardingRequest — response body — request_details / value / http_method: POST headers item

Create a ForwardingRequest — response body — request_details / value / http_method: POST headers item

Field	Type	Presence	Description and constraints
$	object	Root	Header data.
name	string	Required within parent	The header name. Maximum length: 5000
value	string	Required within parent	The header value. Maximum length: 5000

Policy, approvals and errors

SDK function policy ID: stripe.postforwardingrequests. Catalog operation: PostForwardingRequests. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Stripe-Version": "2026-09-30.endive"}

Official provider source