Sha256: f0d737d3b1d8190e724f2e4b2f04e245997f3fcab0aef5b594c802dba950f97d

Contents?: true

Size: 1.33 KB

Versions: 26

Compression:

Stored size: 1.33 KB

Contents

# File generated from our OpenAPI spec
# frozen_string_literal: true

module Stripe
  # To charge a credit or a debit card, you create a `Charge` object. You can
  # retrieve and refund individual charges as well as list all charges. Charges
  # are identified by a unique, random ID.
  #
  # Related guide: [Accept a payment with the Charges API](https://stripe.com/docs/payments/accept-a-payment-charges).
  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

26 entries across 26 versions & 1 rubygems

Version Path
stripe-8.6.0.pre.beta.3 lib/stripe/resources/charge.rb
stripe-8.6.0.pre.beta.2 lib/stripe/resources/charge.rb
stripe-8.6.0.pre.beta.1 lib/stripe/resources/charge.rb
stripe-8.5.0 lib/stripe/resources/charge.rb
stripe-8.5.0.pre.beta.1 lib/stripe/resources/charge.rb
stripe-8.4.0 lib/stripe/resources/charge.rb
stripe-8.4.0.pre.beta.3 lib/stripe/resources/charge.rb
stripe-8.4.0.pre.beta.2 lib/stripe/resources/charge.rb
stripe-8.4.0.pre.beta.1 lib/stripe/resources/charge.rb
stripe-8.3.0 lib/stripe/resources/charge.rb
stripe-8.3.0.pre.beta.1 lib/stripe/resources/charge.rb
stripe-8.2.0 lib/stripe/resources/charge.rb
stripe-8.2.0.pre.beta.3 lib/stripe/resources/charge.rb
stripe-8.2.0.pre.beta.2 lib/stripe/resources/charge.rb
stripe-8.2.0.pre.beta.1 lib/stripe/resources/charge.rb
stripe-8.1.0 lib/stripe/resources/charge.rb
stripe-8.1.0.pre.beta.4 lib/stripe/resources/charge.rb
stripe-8.1.0.pre.beta.3 lib/stripe/resources/charge.rb
stripe-8.1.0.pre.beta.2 lib/stripe/resources/charge.rb
stripe-8.1.0.pre.beta.1 lib/stripe/resources/charge.rb