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_contextnullable object
Context about the request from Stripe’s servers to the destination endpoint.

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

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

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

The ForwardingRequest object

{
  "id": "fwdreq_123",
  "object": "forwarding.request",
  "created": 1234567890,
  "livemode": false,
  "payment_method": "pm_456",
  "request_details": {
    "body": "{\"amount\":{\"value\":1000,\"currency\":\"usd\"},\"paymentMethod\":{\"number\":\"424242******4242\",\"expiryMonth\":\"03\",\"expiryYear\":\"2030\",\"cvc\":\"***\",\"holderName\":\"First Last\"},\"reference\":\"{{REFERENCE_ID}}\"}",
    "headers": [
      {
        "name": "Destination-API-Key",
        "value": "{{DESTINATION_API_KEY}}"
      },
      {
        "name": "Destination-Idempotency-Key",
        "value": "{{DESTINATION_IDEMPOTENCY_KEY}}"
      },
      {
        "name": "Content-Type",
        "value": "application/json"
      }
    ],
    "http_method": "POST"
  },
  "request_context": {
    "destination_ip_address": "35.190.113.80",
    "destination_duration": 234
  },
  "response_details": {
    "body": "{\"transactionId\":\"example1234\"}",
    "headers": [
      {
        "name": "Content-Type",
        "value": "application/json;charset=UTF-8"
      }
    ],
    "status": 200
  },
  "url": "https://endpoint-url/v1/payments",
  "replacements": [
    "card_number",
    "card_expiry",
    "card_cvc",
    "cardholder_name"
  ]
}

Create a ForwardingRequest

Creates a ForwardingRequest object.

Parameters

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

replacementsarray of enumsRequired
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

requestobjectRequired
The request body and headers to be sent to the destination endpoint.

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

metadataobjectPreview 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.

POST /v1/forwarding/requests

Server-side language

curl https://api.stripe.com/v1/forwarding/requests \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
  --data-urlencode url="https://endpoint-url/v1/payments" \
  -d payment_method=pm_card_visa \
  -d "replacements[0]"=card_number \
  -d "replacements[1]"=card_expiry \
  -d "replacements[2]"=card_cvc \
  -d "replacements[3]"=cardholder_name \
  --data-urlencode "request[body]"="{\"amount\":{\"value\":1000,\"currency\":\"usd\"},\"paymentMethod\":{\"number\":\"\",\"expiryMonth\":\"\",\"expiryYear\":\"\",\"cvc\":\"\",\"holderName\":\"\"},\"reference\":\"{{REFERENCE_ID}}\"}" \
  -d "request[headers][0][name]"=Destination-API-Key \
  -d "request[headers][0][value]"={{DESTINATION_API_KEY}} \
  -d "request[headers][1][name]"=Destination-Idempotency-Key \
  -d "request[headers][1][value]"={{DESTINATION_IDEMPOTENCY_KEY}}

Response

{
  "id": "fwdreq_123",
  "object": "forwarding.request",
  "created": 1234567890,
  "livemode": false,
  "payment_method": "pm_456",
  "request_details": {
    "body": "{\"amount\":{\"value\":1000,\"currency\":\"usd\"},\"paymentMethod\":{\"number\":\"424242******4242\",\"expiryMonth\":\"03\",\"expiryYear\":\"2030\",\"cvc\":\"***\",\"holderName\":\"First Last\"},\"reference\":\"{{REFERENCE_ID}}\"}",
    "headers": [
      {
        "name": "Destination-API-Key",
        "value": "{{DESTINATION_API_KEY}}"
      },
      {
        "name": "Destination-Idempotency-Key",
        "value": "{{DESTINATION_IDEMPOTENCY_KEY}}"
      },
      {
        "name": "Content-Type",
        "value": "application/json"
      }
    ],
    "http_method": "POST"
  },
  "request_context": {
    "destination_ip_address": "35.190.113.80",
    "destination_duration": 234
  },
  "response_details": {
    "body": "{\"transactionId\":\"example1234\"}",
    "headers": [
      {
        "name": "Content-Type",
        "value": "application/json;charset=UTF-8"
      }
    ],
    "status": 200
  },
  "url": "https://endpoint-url/v1/payments",
  "replacements": [
    "card_number",
    "card_expiry",
    "card_cvc",
    "cardholder_name"
  ]
}

Retrieve a ForwardingRequest

Retrieves a ForwardingRequest object.

Parameters

No parameters.

Returns

Returns a ForwardingRequest object.

GET /v1/forwarding/requests/:id

Server-side language

curl https://api.stripe.com/v1/forwarding/requests/fwdreq_123 \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:"

Response

{
  "id": "fwdreq_123",
  "object": "forwarding.request",
  "created": 1234567890,
  "livemode": false,
  "payment_method": "pm_456",
  "request_details": {
    "body": "{\"amount\":{\"value\":1000,\"currency\":\"usd\"},\"paymentMethod\":{\"number\":\"424242******4242\",\"expiryMonth\":\"03\",\"expiryYear\":\"2030\",\"cvc\":\"***\",\"holderName\":\"First Last\"},\"reference\":\"{{REFERENCE_ID}}\"}",
    "headers": [
      {
        "name": "Destination-API-Key",
        "value": "{{DESTINATION_API_KEY}}"
      },
      {
        "name": "Destination-Idempotency-Key",
        "value": "{{DESTINATION_IDEMPOTENCY_KEY}}"
      },
      {
        "name": "Content-Type",
        "value": "application/json"
      }
    ],
    "http_method": "POST"
  },
  "request_context": {
    "destination_ip_address": "35.190.113.80",
    "destination_duration": 234
  },
  "response_details": {
    "body": "{\"transactionId\":\"example1234\"}",
    "headers": [
      {
        "name": "Content-Type",
        "value": "application/json;charset=UTF-8"
      }
    ],
    "status": 200
  },
  "url": "https://endpoint-url/v1/payments",
  "replacements": [
    "card_number",
    "card_expiry",
    "card_cvc",
    "cardholder_name"
  ]
}

List all ForwardingRequests

Lists all ForwardingRequest objects.

Parameters

createdobject
Similar to other List endpoints, filters results based on created timestamp. You can pass gt, gte, lt, and lte timestamp values.

ending_beforestring
A pagination cursor to fetch the previous page of the list. The value must be a ForwardingRequest ID.

limitinteger
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

starting_afterstring
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.

GET /v1/forwarding/requests

Server-side language

curl -G https://api.stripe.com/v1/forwarding/requests \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
  -d limit=3

Response

{
  "object": "list",
  "url": "/v1/forwarding/requests",
  "has_more": false,
  "data": [
    {
      "id": "fwdreq_123",
      "object": "forwarding.request",
      "created": 1234567890,
      "livemode": false,
      "payment_method": "pm_456",
      "request_details": {
        "body": "{\"amount\":{\"value\":1000,\"currency\":\"usd\"},\"paymentMethod\":{\"number\":\"424242******4242\",\"expiryMonth\":\"03\",\"expiryYear\":\"2030\",\"cvc\":\"***\",\"holderName\":\"First Last\"},\"reference\":\"{{REFERENCE_ID}}\"}",
        "headers": [
          {
            "name": "Destination-API-Key",
            "value": "{{DESTINATION_API_KEY}}"
          },
          {
            "name": "Destination-Idempotency-Key",
            "value": "{{DESTINATION_IDEMPOTENCY_KEY}}"
          },
          {
            "name": "Content-Type",
            "value": "application/json"
          }
        ],
        "http_method": "POST"
      },
      "request_context": {
        "destination_ip_address": "35.190.113.80",
        "destination_duration": 234
      },
      "response_details": {
        "body": "{\"transactionId\":\"example1234\"}",
        "headers": [
          {
            "name": "Content-Type",
            "value": "application/json;charset=UTF-8"
          }
        ],
        "status": 200
      },
      "url": "https://endpoint-url/v1/payments",
      "replacements": [
        "card_number",
        "card_expiry",
        "card_cvc",
        "cardholder_name"
      ]
    }
  ]
}