Sha256: ba4d1d7138ee2084bf69e064077e2a8e426ff62b29e3a7b894043c80318f72dc

Contents?: true

Size: 1.74 KB

Versions: 15

Compression:

Stored size: 1.74 KB

Contents

# File generated from our OpenAPI spec
# frozen_string_literal: true

module Stripe
  # A `Payout` object is created when you receive funds from Stripe, or when you
  # initiate a payout to either a bank account or debit card of a [connected
  # Stripe account](https://stripe.com/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts,
  # and list all payouts. Payouts are made on [varying
  # schedules](https://stripe.com/docs/connect/manage-payout-schedule), depending on your country and
  # industry.
  #
  # Related guide: [Receiving payouts](https://stripe.com/docs/payouts)
  class Payout < APIResource
    extend Stripe::APIOperations::Create
    extend Stripe::APIOperations::List
    include Stripe::APIOperations::Save

    OBJECT_NAME = "payout"

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

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

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

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

Version data entries

15 entries across 15 versions & 1 rubygems

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