class

Stripe::TreasuryCreditReversal

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

You can reverse some ReceivedCredits depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.

Constants

ERROR_MESSAGE_FOR_NETWORK = "invalid value for \"network\", must be one of [ach, stripe]."
ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [treasury.credit_reversal]."
ERROR_MESSAGE_FOR_STATUS = "invalid value for \"status\", must be one of [canceled, posted, processing]."
MAX_LENGTH_FOR_FINANCIAL_ACCOUNT = 5000
MAX_LENGTH_FOR_HOSTED_REGULATORY_RECEIPT_URL = 5000
MAX_LENGTH_FOR_ID = 5000
MAX_LENGTH_FOR_RECEIVED_CREDIT = 5000
VALID_VALUES_FOR_NETWORK = String.static_array("ach", "stripe")
VALID_VALUES_FOR_OBJECT = String.static_array("treasury.credit_reversal")
VALID_VALUES_FOR_STATUS = String.static_array("canceled", "posted", "processing")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, amount : Int64 | Nil = nil, created : Int64 | Nil = nil, currency : String | Nil = nil, financial_account : String | Nil = nil, hosted_regulatory_receipt_url : String | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, metadata : Hash(String, String) | Nil = nil, network : String | Nil = nil, object : String | Nil = nil, received_credit : String | Nil = nil, status : String | Nil = nil, status_transitions : Stripe::TreasuryReceivedCreditsResourceStatusTransitions | Nil = nil, transaction : Stripe::TreasuryCreditReversalTransaction | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

amount

Amount (in cents) transferred.

Source
amount=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] amount Object to be assigned

Source
created

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

Source
created=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] created Object to be assigned

Source
currency

Three-letter ISO currency code, in lowercase. Must be a supported currency.

Source
currency=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] currency Object to be assigned

Source
financial_account

The FinancialAccount to reverse funds from.

Source
financial_account=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] financial_account Object to be assigned

Source
hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

hosted_regulatory_receipt_url

A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.

Source
hosted_regulatory_receipt_url=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] hosted_regulatory_receipt_url Object to be assigned

Source
id

Unique identifier for the object.

Source
id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned

Source
list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
livemode

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

Source
livemode=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] livemode Object to be assigned

Source
metadata
Source
metadata=(new_value : Hash(String, String) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] metadata Object to be assigned

Source
network

The rails used to reverse the funds.

Source
network=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] network Object to be assigned

Source
object

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

Source
object=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned

Source
received_credit

The ReceivedCredit being reversed.

Source
received_credit=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] received_credit Object to be assigned

Source
status

Status of the CreditReversal

Source
status=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned

Source
status_transitions
Source
status_transitions=(new_value : Stripe::TreasuryReceivedCreditsResourceStatusTransitions | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] status_transitions Object to be assigned

Source
transaction
Source
transaction=(new_value : Stripe::TreasuryCreditReversalTransaction | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] transaction Object to be assigned

Source
valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source