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 valuescard_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.
{
"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.
{
"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.
{
"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"
]
}
{...}
{...}
],
}
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