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 value false if the object exists in test mode.

• metadatanullable objectPreview 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_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.

  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_contextnullable object

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

  Hide child attributes

  • request_context.destination_durationinteger

    The time it took in milliseconds for the destination endpoint to respond.

  • request_context.destination_ip_addressstring

    The IP address of the destination.

• request_detailsnullable object

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

  Hide child attributes

  • request_details.bodystring

    The body payload to send to the destination endpoint.

  • request_details.headersarray of objects

    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.

    Hide child attributes

    • request_details.headers.namestring

      The header name.

    • request_details.headers.valuestring

      The header value.

  • request_details.http_methodenum

    The HTTP method used to call the destination endpoint.

    Possible enum values

    POST The HTTP POST method

• response_detailsnullable object

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

  Hide child attributes

  • response_details.bodystring

    The response body from the destination endpoint to Stripe.

  • response_details.headersarray of objects

    HTTP headers that the destination endpoint returned.

    Hide child attributes

    • response_details.headers.namestring

      The header name.

    • response_details.headers.valuestring

      The header value.

  • response_details.statusinteger

    The HTTP status code that the destination endpoint returned.

• urlnullable string

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