Sha256: a173467a4896ee62a5710bc5cf355768b047d431c1ac3e883d4d944825ee9cfa

Contents?: true

Size: 1.76 KB

Versions: 40

Compression:

Stored size: 1.76 KB

Contents

# File generated from our OpenAPI spec
# frozen_string_literal: true

module Stripe
  # [Stripe Connect](https://stripe.com/docs/connect) platforms can reverse transfers made to a
  # connected account, either entirely or partially, and can also specify whether
  # to refund any related application fees. Transfer reversals add to the
  # platform's balance and subtract from the destination account's balance.
  #
  # Reversing a transfer that was made for a [destination
  # charge](https://stripe.com/docs/connect/destination-charges) is allowed only up to the amount of
  # the charge. It is possible to reverse a
  # [transfer_group](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options)
  # transfer only if the destination account has enough balance to cover the
  # reversal.
  #
  # Related guide: [Reverse transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#reverse-transfers)
  class Reversal < APIResource
    include Stripe::APIOperations::Save

    OBJECT_NAME = "transfer_reversal"
    def self.object_name
      "transfer_reversal"
    end

    def resource_url
      "#{Transfer.resource_url}/#{CGI.escape(transfer)}/reversals" \
        "/#{CGI.escape(id)}"
    end

    def self.update(_id, _params = nil, _opts = nil)
      raise NotImplementedError,
            "Reversals cannot be updated without a transfer ID. Update a " \
            "reversal using `r = Transfer.update_reversal('transfer_id', " \
            "'reversal_id', update_params)`"
    end

    def self.retrieve(_id, _opts = {})
      raise NotImplementedError,
            "Reversals cannot be retrieved without a transfer ID. Retrieve " \
            "a reversal using `Transfer.retrieve_reversal('transfer_id', " \
            "'reversal_id'`"
    end
  end
end

Version data entries

40 entries across 40 versions & 1 rubygems

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