Struct ForwardingRequest

pub struct ForwardingRequest {
    pub created: Timestamp,
    pub id: ForwardingRequestId,
    pub livemode: bool,
    pub metadata: Option<HashMap<String, String>>,
    pub payment_method: String,
    pub replacements: Vec<ForwardingRequestReplacements>,
    pub request_context: Option<ForwardedRequestContext>,
    pub request_details: Option<ForwardedRequestDetails>,
    pub response_details: Option<ForwardedResponseDetails>,
    pub url: Option<String>,
}

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.

Fields

created: Timestamp

Time at which the object was created. Measured in seconds since the Unix epoch.

id: ForwardingRequestId

Unique identifier for the object.

livemode: bool

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

metadata: Option<HashMap<String, String>>

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 PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.

replacements: Vec<ForwardingRequestReplacements>

The field kinds to be replaced in the forwarded request.

request_context: Option<ForwardedRequestContext>

Context about the request from Stripe’s servers to the destination endpoint.

request_details: Option<ForwardedRequestDetails>

The request that was sent to the destination endpoint. We redact any sensitive fields.

response_details: Option<ForwardedResponseDetails>

The response that the destination endpoint returned to us. We redact any sensitive fields.

url: Option<String>

The destination URL for the forwarded request. Must be supported by the config.

Trait Implementations

impl Clone for ForwardingRequest

fn clone(&self) -> ForwardingRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ForwardingRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deserialize for ForwardingRequest

fn begin(out: &mut Option<Self>) -> &mut dyn Visitor

The only correct implementation of this method is:

impl FromValueOpt for ForwardingRequest

fn from_value(v: Value) -> Option<Self>

impl Object for ForwardingRequest

type Id = ForwardingRequestId

The canonical id type for this object.

fn id(&self) -> &Self::Id

The id of the object.

fn into_id(self) -> Self::Id

The owned id of the object.

impl ObjectDeser for ForwardingRequest

type Builder = ForwardingRequestBuilder