Class: Stripe::Forwarding::Request

Inherits:
APIResource show all
Extended by:
APIOperations::Create, APIOperations::List
Defined in:
lib/stripe/resources/forwarding/request.rb

Overview

Instructs Stripe to make a request on your behalf using the destination URL. The destination URL is activated by Stripe at the time of onboarding. Stripe verifies requests with your credentials provided during onboarding, 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](docs.stripe.com/payments/forwarding).

Constant Summary collapse

OBJECT_NAME = 
"forwarding.request"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Methods included from APIOperations::Create

create

Methods included from APIOperations::List

list

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Class Method Details

.create(params = {}, opts = {}) ⇒ Object

Creates a ForwardingRequest object.



32
33
34
35
36
37
38
39
 
# File 'lib/stripe/resources/forwarding/request.rb', line 32

def self.create(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: "/v1/forwarding/requests",
    params: params,
    opts: opts
  )
end

.list(params = {}, opts = {}) ⇒ Object

Lists all ForwardingRequest objects.



42
43
44
45
46
47
48
49
 
# File 'lib/stripe/resources/forwarding/request.rb', line 42

def self.list(params = {}, opts = {})
  request_stripe_object(
    method: :get,
    path: "/v1/forwarding/requests",
    params: params,
    opts: opts
  )
end

.object_name ⇒ Object 



27
28
29
 
# File 'lib/stripe/resources/forwarding/request.rb', line 27

def self.object_name
  "forwarding.request"
end