Class: Stripe::Treasury::CreditReversal

Inherits:
APIResource show all
Extended by:
APIOperations::Create, APIOperations::List
Defined in:
lib/stripe/resources/treasury/credit_reversal.rb

Overview

You can reverse some [ReceivedCredits](stripe.com/docs/api#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.

Defined Under Namespace

Classes: CreateParams, ListParams, RetrieveParams, StatusTransitions

Constant Summary collapse

OBJECT_NAME = 
"treasury.credit_reversal"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Methods included from APIOperations::Create

create

Methods included from APIOperations::List

list

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#amount ⇒ Object (readonly)

Amount (in cents) transferred.



88
89
90
 
# File 'lib/stripe/resources/treasury/credit_reversal.rb', line 88

def amount
  @amount
end

#created ⇒ Object (readonly)

Time at which the object was created. Measured in seconds since the Unix epoch.



91
92
93
 
# File 'lib/stripe/resources/treasury/credit_reversal.rb', line 91

def created
  @created
end

#currency ⇒ Object (readonly)

Three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](stripe.com/docs/currencies).



94
95
96
 
# File 'lib/stripe/resources/treasury/credit_reversal.rb', line 94

def currency
  @currency
end

#financial_account ⇒ Object (readonly)

The FinancialAccount to reverse funds from.



97
98
99
 
# File 'lib/stripe/resources/treasury/credit_reversal.rb', line 97

def 
  @financial_account
end

#hosted_regulatory_receipt_url ⇒ Object (readonly)

A [hosted transaction receipt](stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.



100
101
102
 
# File 'lib/stripe/resources/treasury/credit_reversal.rb', line 100

def hosted_regulatory_receipt_url
  @hosted_regulatory_receipt_url
end

#id ⇒ Object (readonly)

Unique identifier for the object.



103
104
105
 
# File 'lib/stripe/resources/treasury/credit_reversal.rb', line 103

def id
  @id
end

#livemode ⇒ Object (readonly)

Has the value ‘true` if the object exists in live mode or the value `false` if the object exists in test mode.



106
107
108
 
# File 'lib/stripe/resources/treasury/credit_reversal.rb', line 106

def livemode
  @livemode
end

#metadata ⇒ Object (readonly)

Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.



109
110
111
 
# File 'lib/stripe/resources/treasury/credit_reversal.rb', line 109

def metadata
  @metadata
end

#network ⇒ Object (readonly)

The rails used to reverse the funds.



112
113
114
 
# File 'lib/stripe/resources/treasury/credit_reversal.rb', line 112

def network
  @network
end

#object ⇒ Object (readonly)

String representing the object’s type. Objects of the same type share the same value.



115
116
117
 
# File 'lib/stripe/resources/treasury/credit_reversal.rb', line 115

def object
  @object
end

#received_credit ⇒ Object (readonly)

The ReceivedCredit being reversed.



118
119
120
 
# File 'lib/stripe/resources/treasury/credit_reversal.rb', line 118

def received_credit
  @received_credit
end

#status ⇒ Object (readonly)

Status of the CreditReversal



121
122
123
 
# File 'lib/stripe/resources/treasury/credit_reversal.rb', line 121

def status
  @status
end

#status_transitions ⇒ Object (readonly)

Attribute for field status_transitions



124
125
126
 
# File 'lib/stripe/resources/treasury/credit_reversal.rb', line 124

def status_transitions
  @status_transitions
end

#transaction ⇒ Object (readonly)

The Transaction associated with this object.



127
128
129
 
# File 'lib/stripe/resources/treasury/credit_reversal.rb', line 127

def transaction
  @transaction
end

Class Method Details

.create(params = {}, opts = {}) ⇒ Object

Reverses a ReceivedCredit and creates a CreditReversal object.



130
131
132
133
134
135
136
137
 
# File 'lib/stripe/resources/treasury/credit_reversal.rb', line 130

def self.create(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: "/v1/treasury/credit_reversals",
    params: params,
    opts: opts
  )
end

.list(params = {}, opts = {}) ⇒ Object

Returns a list of CreditReversals.



140
141
142
143
144
145
146
147
 
# File 'lib/stripe/resources/treasury/credit_reversal.rb', line 140

def self.list(params = {}, opts = {})
  request_stripe_object(
    method: :get,
    path: "/v1/treasury/credit_reversals",
    params: params,
    opts: opts
  )
end

.object_name ⇒ Object 



12
13
14
 
# File 'lib/stripe/resources/treasury/credit_reversal.rb', line 12

def self.object_name
  "treasury.credit_reversal"
end