Class: Stripe::V2::MoneyManagement::Adjustment

Inherits:
APIResource show all
Defined in:
lib/stripe/resources/v2/money_management/adjustment.rb

Overview

Adjustments represent Stripe-initiated credits or debits to a user balance. They might be used to amend balances due to technical or operational error.

Defined Under Namespace

Classes: AdjustedFlow, Amount

Constant Summary collapse

OBJECT_NAME = 
"v2.money_management.adjustment"

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 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

#==, #[], #[]=, #_get_inner_class_type, 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

#adjusted_flow ⇒ Object (readonly)

If applicable, contains information about the original flow linked to this Adjustment.



54
55
56
 
# File 'lib/stripe/resources/v2/money_management/adjustment.rb', line 54

def adjusted_flow
  @adjusted_flow
end

#amount ⇒ Object (readonly)

The amount of the Adjustment.



56
57
58
 
# File 'lib/stripe/resources/v2/money_management/adjustment.rb', line 56

def amount
  @amount
end

#created ⇒ Object (readonly)

Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.



58
59
60
 
# File 'lib/stripe/resources/v2/money_management/adjustment.rb', line 58

def created
  @created
end

#description ⇒ Object (readonly)

Description of the Adjustment and what it was used for.



60
61
62
 
# File 'lib/stripe/resources/v2/money_management/adjustment.rb', line 60

def description
  @description
end

#financial_account ⇒ Object (readonly)

The FinancialAccount that this adjustment is for.



62
63
64
 
# File 'lib/stripe/resources/v2/money_management/adjustment.rb', line 62

def 
  @financial_account
end

#id ⇒ Object (readonly)

Unique identifier for the object.



64
65
66
 
# File 'lib/stripe/resources/v2/money_management/adjustment.rb', line 64

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.



70
71
72
 
# File 'lib/stripe/resources/v2/money_management/adjustment.rb', line 70

def livemode
  @livemode
end

#object ⇒ Object (readonly)

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



66
67
68
 
# File 'lib/stripe/resources/v2/money_management/adjustment.rb', line 66

def object
  @object
end

#receipt_url ⇒ Object (readonly)

A link to the Stripe-hosted receipt that is provided when money movement is considered regulated under Stripe’s money transmission licenses. The receipt link remains active for 60 days from the Adjustment creation date. After this period, the link will expire and the receipt url value will be null.



68
69
70
 
# File 'lib/stripe/resources/v2/money_management/adjustment.rb', line 68

def receipt_url
  @receipt_url
end

Class Method Details

.field_remappings ⇒ Object 



76
77
78
 
# File 'lib/stripe/resources/v2/money_management/adjustment.rb', line 76

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



72
73
74
 
# File 'lib/stripe/resources/v2/money_management/adjustment.rb', line 72

def self.inner_class_types
  @inner_class_types = { adjusted_flow: AdjustedFlow, amount: Amount }
end

.object_name ⇒ Object 



10
11
12
 
# File 'lib/stripe/resources/v2/money_management/adjustment.rb', line 10

def self.object_name
  "v2.money_management.adjustment"
end