ForwardingRequest class final

ForwardingRequest

Instructs Stripe to make a request on your behalf using the destination URL and HTTP method in the config. A config is set up for each destination URL by Stripe at the time of onboarding. Stripe verifies requests with your credentials in the config, and injects card details from the payment_method into the request. Stripe redacts all sensitive fields and headers, including authentication credentials and card numbers, before storing the request and response data in the forwarding Request object, which are subject to a 30-day retention period. You can provide a Stripe idempotency key to make sure that requests with the same key result in only one outbound request. The Stripe idempotency key provided should be unique and different from any idempotency keys provided on the underlying third-party request. Forwarding Requests are synchronous requests that return a response or time out according to Stripe’s limits. Related guide: [Forward card details to third-party API endpoints](https://docs.stripe.com/payments/forwarding).

Implemented types

Constructors

ForwardingRequest({required String config, required DateTime created, required String id, required bool livemode, required String paymentMethod, required List<ForwardingRequestReplacementsItem> replacements, ForwardedRequestContext? requestContext, ForwardedRequestDetails? requestDetails, ForwardedResponseDetails? responseDetails, String? url})
ForwardingRequest
const
ForwardingRequest.fromJson(Object? json)
factory

Properties

config String
final
created DateTime
final
hashCode int
The hash code for this object.
no setterinherited
id String
final
livemode bool
final
object String
The resource's type.
final
paymentMethod String
final
replacements List<ForwardingRequestReplacementsItem>
final
requestContext ForwardedRequestContext?
final
requestDetails ForwardedRequestDetails?
final
responseDetails ForwardedResponseDetails?
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
url String?
final

Methods

encodeWith<V>(Encoder<V> encoder) → V
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Map<String, Object?>
override
toString() String
A string representation of this object.
override

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Methods

encode<V>(ForwardingRequest instance, Encoder<V> encoder) → V