Create a ForwardingRequest

Creates a ForwardingRequest object.

Parameters

  • configstringRequired

    The Forwarding Config used when making the forwarded request. The config specifes the HTTP method, merchant credentials, connection settings, and supported destination URLs.

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

Returns

Returns a ForwardingRequest object.

POST /v1/forwarding/requests
curl https://api.stripe.com/v1/forwarding/requests \
-u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
-d config=fwdcfg_acct_TESTCONFIG_demo_payments \
--data-urlencode url="https://forwarding-api-demo.stripedemos.com/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\"},\"card\":{\"number\":\"\",\"exp_month\":\"\",\"exp_year\":\"\",\"cvc\":\"\",\"name\":\"\"},\"reference\":\"Your order number\"}" \
-d "request[headers][0][name]"=Authorization \
-d "request[headers][0][value]"="Bearer eyJhbGciOiJIUzI1NiJ9.Zm9yd2FyZGluZy1hcGktZGVtbw.2qoK37CNBmMjMDRERSYUSE-YrjsTgGhHnxMeqOxjrAg"
Response
{
"id": "fwdreq_123",
"object": "forwarding.request",
"config": "fwdcfg_acct_TESTCONFIG_demo_payments",
"created": 1234567890,
"livemode": false,
"payment_method": "pm_456",
"request_details": {
"body": "{\"amount\":{\"value\":1000,\"currency\":\"usd\"},\"card\":{\"number\":\"424242******4242\",\"exp_month\":\"03\",\"exp_year\":\"2030\",\"cvc\":\"***\",\"name\":\"First Last\"},\"reference\":\"Your order number\"}",
"headers": [
{
"name": "Authorization",
"value": "Bearer *******************************************************************************************"
},
{
"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://forwarding-api-demo.stripedemos.com/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
curl https://api.stripe.com/v1/forwarding/requests/fwdreq_123 \
-u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:"
Response
{
"id": "fwdreq_123",
"object": "forwarding.request",
"config": "fwdcfg_acct_TESTCONFIG_demo_payments",
"created": 1234567890,
"livemode": false,
"payment_method": "pm_456",
"request_details": {
"body": "{\"amount\":{\"value\":1000,\"currency\":\"usd\"},\"card\":{\"number\":\"424242******4242\",\"exp_month\":\"03\",\"exp_year\":\"2030\",\"cvc\":\"***\",\"name\":\"First Last\"},\"reference\":\"Your order number\"}",
"headers": [
{
"name": "Authorization",
"value": "Bearer *******************************************************************************************"
},
{
"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://forwarding-api-demo.stripedemos.com/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
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",
"config": "fwdcfg_acct_TESTCONFIG_demo_payments",
"created": 1234567890,
"livemode": false,
"payment_method": "pm_456",
"request_details": {
"body": "{\"amount\":{\"value\":1000,\"currency\":\"usd\"},\"card\":{\"number\":\"424242******4242\",\"exp_month\":\"03\",\"exp_year\":\"2030\",\"cvc\":\"***\",\"name\":\"First Last\"},\"reference\":\"Your order number\"}",
"headers": [
{
"name": "Authorization",
"value": "Bearer *******************************************************************************************"
},
{
"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://forwarding-api-demo.stripedemos.com/payments",
"replacements": [
"card_number",
"card_expiry",
"card_cvc",
"cardholder_name"
]
}
{...}
{...}
],
}

Webhook Endpoints

You can configure webhook endpoints via the API to be notified about events that happen in your Stripe account or connected accounts.

Most users configure webhooks from the dashboard, which provides a user interface for registering and testing your webhook endpoints.

Related guide: Setting up webhooks

Stripe Shell
Test mode
Welcome to the Stripe Shell! Stripe Shell is a browser-based shell with the Stripe CLI pre-installed. Log in to your Stripe account and press Control + Backtick (`) on your keyboard to start managing your Stripe resources in test mode. - View supported Stripe commands: - Find webhook events: - Listen for webhook events: - Call Stripe APIs: stripe [api resource] [operation] (e.g., )
The Stripe Shell is best experienced on desktop.
$