Sha256: cb4e0f0ae2073a8768ebbc03977a848707cbf58872102fa1a4624e57f78a40cd

Contents?: true

Size: 1.92 KB

Versions: 34

Compression:

Stored size: 1.92 KB

Contents

# File generated from our OpenAPI spec
# frozen_string_literal: true

module Stripe
  module Forwarding
    # 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](https://docs.stripe.com/payments/forwarding).
    class Request < APIResource
      extend Stripe::APIOperations::Create
      extend Stripe::APIOperations::List

      OBJECT_NAME = "forwarding.request"
      def self.object_name
        "forwarding.request"
      end

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

      # Lists all ForwardingRequest objects.
      def self.list(filters = {}, opts = {})
        request_stripe_object(
          method: :get,
          path: "/v1/forwarding/requests",
          params: filters,
          opts: opts
        )
      end
    end
  end
end

Version data entries

34 entries across 34 versions & 1 rubygems

Version Path
stripe-13.3.0.pre.beta.1 lib/stripe/resources/forwarding/request.rb
stripe-13.2.0 lib/stripe/resources/forwarding/request.rb
stripe-13.1.2 lib/stripe/resources/forwarding/request.rb
stripe-13.2.0.pre.beta.3 lib/stripe/resources/forwarding/request.rb
stripe-13.2.0.pre.beta.2 lib/stripe/resources/forwarding/request.rb
stripe-13.1.1 lib/stripe/resources/forwarding/request.rb
stripe-13.2.0.pre.beta.1 lib/stripe/resources/forwarding/request.rb
stripe-13.1.0 lib/stripe/resources/forwarding/request.rb
stripe-13.0.2 lib/stripe/resources/forwarding/request.rb
stripe-13.1.0.pre.beta.3 lib/stripe/resources/forwarding/request.rb
stripe-13.0.1 lib/stripe/resources/forwarding/request.rb
stripe-13.1.0.pre.beta.2 lib/stripe/resources/forwarding/request.rb
stripe-13.0.0 lib/stripe/resources/forwarding/request.rb
stripe-12.7.0.pre.beta.2 lib/stripe/resources/forwarding/request.rb
stripe-12.7.0.pre.beta.1 lib/stripe/resources/forwarding/request.rb
stripe-12.6.0 lib/stripe/resources/forwarding/request.rb
stripe-12.6.0.pre.beta.1 lib/stripe/resources/forwarding/request.rb
stripe-12.5.0 lib/stripe/resources/forwarding/request.rb
stripe-12.5.0.pre.beta.2 lib/stripe/resources/forwarding/request.rb
stripe-12.5.0.pre.beta.1 lib/stripe/resources/forwarding/request.rb