class

Stripe::TransferReversal

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

Stripe 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 is allowed only up to the amount of the charge. It is possible to reverse a transfer_group transfer only if the destination account has enough balance to cover the reversal. Related guide: Reverse transfers

Constants

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [transfer_reversal]."
MAX_LENGTH_FOR_ID = 5000
VALID_VALUES_FOR_OBJECT = String.static_array("transfer_reversal")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, amount : Int64 | Nil = nil, balance_transaction : Stripe::FeeRefundBalanceTransaction | Nil = nil, created : Int64 | Nil = nil, currency : String | Nil = nil, destination_payment_refund : Stripe::TransferReversalDestinationPaymentRefund | Nil = nil, id : String | Nil = nil, metadata : Hash(String, String) | Nil = nil, object : String | Nil = nil, source_refund : Stripe::TransferReversalSourceRefund | Nil = nil, transfer : Stripe::TransferReversalTransfer | 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 (or local equivalent).

Source
amount=(new_value : Int64 | Nil)

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

Source
balance_transaction
Source
balance_transaction=(new_value : Stripe::FeeRefundBalanceTransaction | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] balance_transaction 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
destination_payment_refund
Source
destination_payment_refund=(new_value : Stripe::TransferReversalDestinationPaymentRefund | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] destination_payment_refund 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

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
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
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
source_refund
Source
source_refund=(new_value : Stripe::TransferReversalSourceRefund | Nil)

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

Source
transfer
Source
transfer=(new_value : Stripe::TransferReversalTransfer | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] transfer 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