Create a ForwardingRequest

Changed on

Creates a ForwardingRequest object.

post/v1/forwarding/requests

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/forwarding/requests
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Request body application/x-www-form-urlencoded

expandstring[]

Specifies which fields in the response should be expanded.

metadataobject

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.

payment_methodstring required

The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.

replacementsstring[] required

The field kinds to be replaced in the forwarded request.

urlstring required

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

Response

Successful response.

createdinteger required

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

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

metadataobject nullable

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.

object'forwarding.request' required

String representing the object's type. Objects of the same type share the same value.

payment_methodstring required

The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.

replacementsstring[] required

The field kinds to be replaced in the forwarded request.

urlstring nullable

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

Changes

  • c113b1939b8fRevision changes
    • info

      added the optional property ////// to the response with the status

  • 7b8f614372caRevision changes
    • info

      added the optional property ////////// to the response with the status

Some revisions have not been checked yet.