Sha256: 8efcaa7715c95f1dda12e0a7d8b43a80170237d08413c1e5512f79de9d0e2d48

Contents?: true

Size: 1.37 KB

Versions: 32

Compression:

Stored size: 1.37 KB

Contents

# File generated from our OpenAPI spec
# frozen_string_literal: true

module Stripe
  # The `Charge` object represents a single attempt to move money into your Stripe account.
  # PaymentIntent confirmation is the most common way to create Charges, but transferring
  # money to a different Stripe account through Connect also creates Charges.
  # Some legacy payment flows create Charges directly, which is not recommended for new integrations.
  class Charge < APIResource
    extend Stripe::APIOperations::Create
    extend Stripe::APIOperations::List
    extend Stripe::APIOperations::Search
    include Stripe::APIOperations::Save

    OBJECT_NAME = "charge"

    def capture(params = {}, opts = {})
      request_stripe_object(
        method: :post,
        path: format("/v1/charges/%<charge>s/capture", { charge: CGI.escape(self["id"]) }),
        params: params,
        opts: opts
      )
    end

    def self.capture(charge, params = {}, opts = {})
      request_stripe_object(
        method: :post,
        path: format("/v1/charges/%<charge>s/capture", { charge: CGI.escape(charge) }),
        params: params,
        opts: opts
      )
    end

    def self.search(params = {}, opts = {})
      _search("/v1/charges/search", params, opts)
    end

    def self.search_auto_paging_each(params = {}, opts = {}, &blk)
      search(params, opts).auto_paging_each(&blk)
    end
  end
end

Version data entries

32 entries across 32 versions & 1 rubygems

Version Path
stripe-10.5.0.pre.beta.1 lib/stripe/resources/charge.rb
stripe-10.4.0 lib/stripe/resources/charge.rb
stripe-10.4.0.pre.beta.1 lib/stripe/resources/charge.rb
stripe-10.3.0 lib/stripe/resources/charge.rb
stripe-10.3.0.pre.beta.1 lib/stripe/resources/charge.rb
stripe-10.2.0 lib/stripe/resources/charge.rb
stripe-10.2.0.pre.beta.1 lib/stripe/resources/charge.rb
stripe-10.1.0 lib/stripe/resources/charge.rb
stripe-10.1.0.pre.beta.2 lib/stripe/resources/charge.rb
stripe-10.1.0.pre.beta.1 lib/stripe/resources/charge.rb
stripe-10.0.0 lib/stripe/resources/charge.rb
stripe-9.5.0.pre.beta.2 lib/stripe/resources/charge.rb
stripe-9.5.0.pre.beta.1 lib/stripe/resources/charge.rb
stripe-9.4.0 lib/stripe/resources/charge.rb
stripe-9.4.0.pre.beta.3 lib/stripe/resources/charge.rb
stripe-9.4.0.pre.beta.2 lib/stripe/resources/charge.rb
stripe-9.4.0.pre.beta.1 lib/stripe/resources/charge.rb
stripe-9.3.0 lib/stripe/resources/charge.rb
stripe-9.3.0.pre.beta.1 lib/stripe/resources/charge.rb
stripe-9.2.0 lib/stripe/resources/charge.rb