Sha256: 6b5f28e930aeea42c3cb932fc45b703f3bd2ef72a4e4b73a322511064ba2cc34

Contents?: true

Size: 1.56 KB

Versions: 20

Compression:

Stored size: 1.56 KB

Contents

# File generated from our OpenAPI spec
# frozen_string_literal: true

module Stripe
  class TopupService < StripeService
    # Cancels a top-up. Only pending top-ups can be canceled.
    def cancel(topup, params = {}, opts = {})
      request(
        method: :post,
        path: format("/v1/topups/%<topup>s/cancel", { topup: CGI.escape(topup) }),
        params: params,
        opts: opts,
        base_address: :api
      )
    end

    # Top up the balance of an account
    def create(params = {}, opts = {})
      request(method: :post, path: "/v1/topups", params: params, opts: opts, base_address: :api)
    end

    # Returns a list of top-ups.
    def list(params = {}, opts = {})
      request(method: :get, path: "/v1/topups", params: params, opts: opts, base_address: :api)
    end

    # Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.
    def retrieve(topup, params = {}, opts = {})
      request(
        method: :get,
        path: format("/v1/topups/%<topup>s", { topup: CGI.escape(topup) }),
        params: params,
        opts: opts,
        base_address: :api
      )
    end

    # Updates the metadata of a top-up. Other top-up details are not editable by design.
    def update(topup, params = {}, opts = {})
      request(
        method: :post,
        path: format("/v1/topups/%<topup>s", { topup: CGI.escape(topup) }),
        params: params,
        opts: opts,
        base_address: :api
      )
    end
  end
end

Version data entries

20 entries across 20 versions & 1 rubygems

Version Path
stripe-13.5.0 lib/stripe/services/topup_service.rb
stripe-13.4.1 lib/stripe/services/topup_service.rb
stripe-13.4.0 lib/stripe/services/topup_service.rb
stripe-13.3.1 lib/stripe/services/topup_service.rb
stripe-13.3.0 lib/stripe/services/topup_service.rb
stripe-13.3.0.pre.beta.3 lib/stripe/services/topup_service.rb
stripe-13.3.0.pre.beta.2 lib/stripe/services/topup_service.rb
stripe-13.3.0.pre.beta.1 lib/stripe/services/topup_service.rb
stripe-13.2.0 lib/stripe/services/topup_service.rb
stripe-13.1.2 lib/stripe/services/topup_service.rb
stripe-13.2.0.pre.beta.3 lib/stripe/services/topup_service.rb
stripe-13.2.0.pre.beta.2 lib/stripe/services/topup_service.rb
stripe-13.1.1 lib/stripe/services/topup_service.rb
stripe-13.2.0.pre.beta.1 lib/stripe/services/topup_service.rb
stripe-13.1.0 lib/stripe/services/topup_service.rb
stripe-13.0.2 lib/stripe/services/topup_service.rb
stripe-13.1.0.pre.beta.3 lib/stripe/services/topup_service.rb
stripe-13.0.1 lib/stripe/services/topup_service.rb
stripe-13.1.0.pre.beta.2 lib/stripe/services/topup_service.rb
stripe-13.0.0 lib/stripe/services/topup_service.rb